diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index 70c0060a..189aa3a6 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -37,7 +37,7 @@ type AccountServiceIface interface { EnableAccount(p *EnableAccountParams) (*EnableAccountResponse, error) NewEnableAccountParams() *EnableAccountParams IsAccountAllowedToCreateOfferingsWithTags(p *IsAccountAllowedToCreateOfferingsWithTagsParams) (*IsAccountAllowedToCreateOfferingsWithTagsResponse, error) - NewIsAccountAllowedToCreateOfferingsWithTagsParams() *IsAccountAllowedToCreateOfferingsWithTagsParams + NewIsAccountAllowedToCreateOfferingsWithTagsParams(id string) *IsAccountAllowedToCreateOfferingsWithTagsParams LinkAccountToLdap(p *LinkAccountToLdapParams) (*LinkAccountToLdapResponse, error) NewLinkAccountToLdapParams(account string, domainid string, ldapdomain string) *LinkAccountToLdapParams ListAccounts(p *ListAccountsParams) (*ListAccountsResponse, error) @@ -443,6 +443,7 @@ func (s *AccountService) CreateAccount(p *CreateAccountParams) (*CreateAccountRe type CreateAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -510,6 +511,7 @@ type CreateAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -770,6 +772,7 @@ func (s *AccountService) DisableAccount(p *DisableAccountParams) (*DisableAccoun type DisableAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -837,6 +840,7 @@ type DisableAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -969,6 +973,7 @@ func (s *AccountService) EnableAccount(p *EnableAccountParams) (*EnableAccountRe type EnableAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -1036,6 +1041,7 @@ type EnableAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1096,9 +1102,10 @@ func (p *IsAccountAllowedToCreateOfferingsWithTagsParams) GetId() (string, bool) // You should always use this function to get a new IsAccountAllowedToCreateOfferingsWithTagsParams instance, // as then you are sure you have configured all required params -func (s *AccountService) NewIsAccountAllowedToCreateOfferingsWithTagsParams() *IsAccountAllowedToCreateOfferingsWithTagsParams { +func (s *AccountService) NewIsAccountAllowedToCreateOfferingsWithTagsParams(id string) *IsAccountAllowedToCreateOfferingsWithTagsParams { p := &IsAccountAllowedToCreateOfferingsWithTagsParams{} p.p = make(map[string]interface{}) + p.p["id"] = id return p } @@ -1354,6 +1361,9 @@ func (p *ListAccountsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("accounttype", vv) } + if v, found := p.p["apikeyaccess"]; found { + u.Set("apikeyaccess", v.(string)) + } if v, found := p.p["details"]; found { vv := strings.Join(v.([]string), ",") u.Set("details", vv) @@ -1424,6 +1434,27 @@ func (p *ListAccountsParams) GetAccounttype() (int, bool) { return value, ok } +func (p *ListAccountsParams) SetApikeyaccess(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["apikeyaccess"] = v +} + +func (p *ListAccountsParams) ResetApikeyaccess() { + if p.p != nil && p.p["apikeyaccess"] != nil { + delete(p.p, "apikeyaccess") + } +} + +func (p *ListAccountsParams) GetApikeyaccess() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["apikeyaccess"].(string) + return value, ok +} + func (p *ListAccountsParams) SetDetails(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1811,6 +1842,7 @@ type ListAccountsResponse struct { type Account struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -1878,6 +1910,7 @@ type AccountUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2326,6 +2359,7 @@ func (s *AccountService) LockAccount(p *LockAccountParams) (*LockAccountResponse type LockAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2393,6 +2427,7 @@ type LockAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2548,6 +2583,7 @@ func (s *AccountService) MarkDefaultZoneForAccount(p *MarkDefaultZoneForAccountP type MarkDefaultZoneForAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2615,6 +2651,7 @@ type MarkDefaultZoneForAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2655,6 +2692,9 @@ func (p *UpdateAccountParams) toURLValues() url.Values { u.Set(fmt.Sprintf("accountdetails[0].%s", k), m[k]) } } + if v, found := p.p["apikeyaccess"]; found { + u.Set("apikeyaccess", v.(string)) + } if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } @@ -2715,6 +2755,27 @@ func (p *UpdateAccountParams) GetAccountdetails() (map[string]string, bool) { return value, ok } +func (p *UpdateAccountParams) SetApikeyaccess(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["apikeyaccess"] = v +} + +func (p *UpdateAccountParams) ResetApikeyaccess() { + if p.p != nil && p.p["apikeyaccess"] != nil { + delete(p.p, "apikeyaccess") + } +} + +func (p *UpdateAccountParams) GetApikeyaccess() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["apikeyaccess"].(string) + return value, ok +} + func (p *UpdateAccountParams) SetDomainid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2846,6 +2907,7 @@ func (s *AccountService) UpdateAccount(p *UpdateAccountParams) (*UpdateAccountRe type UpdateAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2913,6 +2975,7 @@ type UpdateAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` diff --git a/cloudstack/AccountService_mock.go b/cloudstack/AccountService_mock.go index 52ae1565..6e04bc05 100644 --- a/cloudstack/AccountService_mock.go +++ b/cloudstack/AccountService_mock.go @@ -349,17 +349,17 @@ func (mr *MockAccountServiceIfaceMockRecorder) NewEnableAccountParams() *gomock. } // NewIsAccountAllowedToCreateOfferingsWithTagsParams mocks base method. -func (m *MockAccountServiceIface) NewIsAccountAllowedToCreateOfferingsWithTagsParams() *IsAccountAllowedToCreateOfferingsWithTagsParams { +func (m *MockAccountServiceIface) NewIsAccountAllowedToCreateOfferingsWithTagsParams(id string) *IsAccountAllowedToCreateOfferingsWithTagsParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewIsAccountAllowedToCreateOfferingsWithTagsParams") + ret := m.ctrl.Call(m, "NewIsAccountAllowedToCreateOfferingsWithTagsParams", id) ret0, _ := ret[0].(*IsAccountAllowedToCreateOfferingsWithTagsParams) return ret0 } // NewIsAccountAllowedToCreateOfferingsWithTagsParams indicates an expected call of NewIsAccountAllowedToCreateOfferingsWithTagsParams. -func (mr *MockAccountServiceIfaceMockRecorder) NewIsAccountAllowedToCreateOfferingsWithTagsParams() *gomock.Call { +func (mr *MockAccountServiceIfaceMockRecorder) NewIsAccountAllowedToCreateOfferingsWithTagsParams(id any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewIsAccountAllowedToCreateOfferingsWithTagsParams", reflect.TypeOf((*MockAccountServiceIface)(nil).NewIsAccountAllowedToCreateOfferingsWithTagsParams)) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewIsAccountAllowedToCreateOfferingsWithTagsParams", reflect.TypeOf((*MockAccountServiceIface)(nil).NewIsAccountAllowedToCreateOfferingsWithTagsParams), id) } // NewLinkAccountToLdapParams mocks base method. diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index e961a4e1..04dcc7a2 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -1131,6 +1131,7 @@ func (s *AffinityGroupService) UpdateVMAffinityGroup(p *UpdateVMAffinityGroupPar type UpdateVMAffinityGroupResponse struct { Account string `json:"account"` Affinitygroup []UpdateVMAffinityGroupResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/BrocadeVCSService.go b/cloudstack/BrocadeVCSService.go index 319a2679..571b3433 100644 --- a/cloudstack/BrocadeVCSService.go +++ b/cloudstack/BrocadeVCSService.go @@ -526,6 +526,7 @@ type BrocadeVcsDeviceNetwork struct { Sentbytes int64 `json:"sentbytes"` Service []BrocadeVcsDeviceNetworkService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` diff --git a/cloudstack/ClusterService.go b/cloudstack/ClusterService.go index c0a69f54..46843825 100644 --- a/cloudstack/ClusterService.go +++ b/cloudstack/ClusterService.go @@ -1446,6 +1446,9 @@ func (p *ListClustersParams) toURLValues() url.Values { if v, found := p.p["allocationstate"]; found { u.Set("allocationstate", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clustertype"]; found { u.Set("clustertype", v.(string)) } @@ -1506,6 +1509,27 @@ func (p *ListClustersParams) GetAllocationstate() (string, bool) { return value, ok } +func (p *ListClustersParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListClustersParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListClustersParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListClustersParams) SetClustertype(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2104,6 +2128,9 @@ func (p *ListClustersMetricsParams) toURLValues() url.Values { if v, found := p.p["allocationstate"]; found { u.Set("allocationstate", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clustertype"]; found { u.Set("clustertype", v.(string)) } @@ -2164,6 +2191,27 @@ func (p *ListClustersMetricsParams) GetAllocationstate() (string, bool) { return value, ok } +func (p *ListClustersMetricsParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListClustersMetricsParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListClustersMetricsParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListClustersMetricsParams) SetClustertype(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index 1945c524..1978a45a 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -1351,6 +1351,7 @@ type UpdateStorageCapabilitiesResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/FirewallService.go b/cloudstack/FirewallService.go index 4e0e5de7..c299de5e 100644 --- a/cloudstack/FirewallService.go +++ b/cloudstack/FirewallService.go @@ -4436,6 +4436,10 @@ func (p *UpdatePortForwardingRuleParams) toURLValues() url.Values { if p.p == nil { return u } + 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)) } @@ -4463,6 +4467,27 @@ func (p *UpdatePortForwardingRuleParams) toURLValues() url.Values { return u } +func (p *UpdatePortForwardingRuleParams) SetCidrlist(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cidrlist"] = v +} + +func (p *UpdatePortForwardingRuleParams) ResetCidrlist() { + if p.p != nil && p.p["cidrlist"] != nil { + delete(p.p, "cidrlist") + } +} + +func (p *UpdatePortForwardingRuleParams) GetCidrlist() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cidrlist"].([]string) + return value, ok +} + func (p *UpdatePortForwardingRuleParams) SetCustomid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index b3a348b7..d16aed54 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -2197,60 +2197,90 @@ type FindHostsForMigrationResponse struct { } type HostForMigration struct { - Averageload int64 `json:"averageload"` - Capabilities string `json:"capabilities"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Clustertype string `json:"clustertype"` - Cpuallocated string `json:"cpuallocated"` - Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` - Cpuallocatedvalue int64 `json:"cpuallocatedvalue"` - Cpuallocatedwithoverprovisioning string `json:"cpuallocatedwithoverprovisioning"` - Cpunumber int `json:"cpunumber"` - Cpuspeed int64 `json:"cpuspeed"` - Cpuused string `json:"cpuused"` - Cpuwithoverprovisioning string `json:"cpuwithoverprovisioning"` - Created string `json:"created"` - Disconnected string `json:"disconnected"` - Disksizeallocated int64 `json:"disksizeallocated"` - Disksizetotal int64 `json:"disksizetotal"` - Events string `json:"events"` - Explicithosttags string `json:"explicithosttags"` - Hahost bool `json:"hahost"` - Hasenoughcapacity bool `json:"hasenoughcapacity"` - Hosttags string `json:"hosttags"` - Hypervisor string `json:"hypervisor"` - Hypervisorversion string `json:"hypervisorversion"` - Id string `json:"id"` - Implicithosttags string `json:"implicithosttags"` - Ipaddress string `json:"ipaddress"` - Islocalstorageactive bool `json:"islocalstorageactive"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lastpinged string `json:"lastpinged"` - Managementserverid UUID `json:"managementserverid"` - Memoryallocated string `json:"memoryallocated"` - Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` - Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` - Memorytotal int64 `json:"memorytotal"` - Memoryused int64 `json:"memoryused"` - Memorywithoverprovisioning string `json:"memorywithoverprovisioning"` - Name string `json:"name"` - Networkkbsread int64 `json:"networkkbsread"` - Networkkbswrite int64 `json:"networkkbswrite"` - Oscategoryid string `json:"oscategoryid"` - Oscategoryname string `json:"oscategoryname"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Removed string `json:"removed"` - RequiresStorageMotion bool `json:"requiresStorageMotion"` - Resourcestate string `json:"resourcestate"` - State string `json:"state"` - Suitableformigration bool `json:"suitableformigration"` - Type string `json:"type"` - Version string `json:"version"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Annotation string `json:"annotation"` + Arch string `json:"arch"` + Capabilities string `json:"capabilities"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Clustertype string `json:"clustertype"` + Cpuallocated string `json:"cpuallocated"` + Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` + Cpuallocatedvalue int64 `json:"cpuallocatedvalue"` + Cpuallocatedwithoverprovisioning string `json:"cpuallocatedwithoverprovisioning"` + Cpuloadaverage float64 `json:"cpuloadaverage"` + Cpunumber int `json:"cpunumber"` + Cpusockets int `json:"cpusockets"` + Cpuspeed int64 `json:"cpuspeed"` + Cpuused string `json:"cpuused"` + Cpuwithoverprovisioning string `json:"cpuwithoverprovisioning"` + Created string `json:"created"` + Details map[string]string `json:"details"` + Disconnected string `json:"disconnected"` + Disksizeallocated int64 `json:"disksizeallocated"` + Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` + Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` + Gpugroup []HostForMigrationGpugroup `json:"gpugroup"` + Hahost bool `json:"hahost"` + Hasannotations bool `json:"hasannotations"` + Hasenoughcapacity bool `json:"hasenoughcapacity"` + Hostha HAForHostResponse `json:"hostha"` + Hosttags string `json:"hosttags"` + Hypervisor string `json:"hypervisor"` + Hypervisorversion string `json:"hypervisorversion"` + Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` + Ipaddress string `json:"ipaddress"` + Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lastannotated string `json:"lastannotated"` + Lastpinged string `json:"lastpinged"` + Managementserverid UUID `json:"managementserverid"` + Memoryallocated int64 `json:"memoryallocated"` + Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` + Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` + Memorytotal int64 `json:"memorytotal"` + Memoryused int64 `json:"memoryused"` + Memorywithoverprovisioning string `json:"memorywithoverprovisioning"` + Name string `json:"name"` + Networkkbsread int64 `json:"networkkbsread"` + Networkkbswrite int64 `json:"networkkbswrite"` + Oscategoryid string `json:"oscategoryid"` + Oscategoryname string `json:"oscategoryname"` + Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Removed string `json:"removed"` + RequiresStorageMotion bool `json:"requiresStorageMotion"` + Resourcestate string `json:"resourcestate"` + State string `json:"state"` + Suitableformigration bool `json:"suitableformigration"` + Type string `json:"type"` + Ueficapability bool `json:"ueficapability"` + Username string `json:"username"` + Version string `json:"version"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type HostForMigrationGpugroup struct { + Gpugroupname string `json:"gpugroupname"` + Vgpu []HostForMigrationGpugroupVgpu `json:"vgpu"` +} + +type HostForMigrationGpugroupVgpu struct { + Maxcapacity int64 `json:"maxcapacity"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` + Maxvgpuperpgpu int64 `json:"maxvgpuperpgpu"` + Remainingcapacity int64 `json:"remainingcapacity"` + Vgputype string `json:"vgputype"` + Videoram int64 `json:"videoram"` } type ListDedicatedHostsParams struct { @@ -2642,6 +2672,9 @@ func (p *ListHostsParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clusterid"]; found { u.Set("clusterid", v.(string)) } @@ -2701,6 +2734,27 @@ func (p *ListHostsParams) toURLValues() url.Values { return u } +func (p *ListHostsParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListHostsParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListHostsParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListHostsParams) SetClusterid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3264,6 +3318,9 @@ func (p *ListHostsMetricsParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clusterid"]; found { u.Set("clusterid", v.(string)) } @@ -3323,6 +3380,27 @@ func (p *ListHostsMetricsParams) toURLValues() url.Values { return u } +func (p *ListHostsMetricsParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListHostsMetricsParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListHostsMetricsParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListHostsMetricsParams) SetClusterid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index 339cc519..1ceb3951 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -189,6 +189,7 @@ func (s *ISOService) AttachIso(p *AttachIsoParams) (*AttachIsoResponse, error) { type AttachIsoResponse struct { Account string `json:"account"` Affinitygroup []AttachIsoResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -807,6 +808,7 @@ func (s *ISOService) DetachIso(p *DetachIsoParams) (*DetachIsoResponse, error) { type DetachIsoResponse struct { Account string `json:"account"` Affinitygroup []DetachIsoResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/InternalLBService.go b/cloudstack/InternalLBService.go index 4e68b467..3b7c0444 100644 --- a/cloudstack/InternalLBService.go +++ b/cloudstack/InternalLBService.go @@ -1039,6 +1039,7 @@ type ListInternalLoadBalancerVMsResponse struct { type InternalLoadBalancerVM struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -1186,6 +1187,7 @@ func (s *InternalLBService) StartInternalLoadBalancerVM(p *StartInternalLoadBala type StartInternalLoadBalancerVMResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -1358,6 +1360,7 @@ func (s *InternalLBService) StopInternalLoadBalancerVM(p *StopInternalLoadBalanc type StopInternalLoadBalancerVMResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index b6ccc8e2..426d4109 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -326,6 +326,7 @@ func (s *KubernetesService) AddKubernetesSupportedVersion(p *AddKubernetesSuppor } type AddKubernetesSupportedVersionResponse struct { + Arch string `json:"arch"` Created string `json:"created"` Directdownload bool `json:"directdownload"` Id string `json:"id"` @@ -1656,6 +1657,9 @@ func (p *ListKubernetesSupportedVersionsParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -1682,6 +1686,27 @@ func (p *ListKubernetesSupportedVersionsParams) toURLValues() url.Values { return u } +func (p *ListKubernetesSupportedVersionsParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListKubernetesSupportedVersionsParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListKubernetesSupportedVersionsParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListKubernetesSupportedVersionsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1941,6 +1966,7 @@ type ListKubernetesSupportedVersionsResponse struct { } type KubernetesSupportedVersion struct { + Arch string `json:"arch"` Created string `json:"created"` Directdownload bool `json:"directdownload"` Id string `json:"id"` @@ -2519,6 +2545,7 @@ func (s *KubernetesService) UpdateKubernetesSupportedVersion(p *UpdateKubernetes } type UpdateKubernetesSupportedVersionResponse struct { + Arch string `json:"arch"` Created string `json:"created"` Directdownload bool `json:"directdownload"` Id string `json:"id"` diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index 6a78f38f..5bfe1001 100644 --- a/cloudstack/LDAPService.go +++ b/cloudstack/LDAPService.go @@ -1152,6 +1152,7 @@ func (s *LDAPService) LdapCreateAccount(p *LdapCreateAccountParams) (*LdapCreate type LdapCreateAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` + Apikeyaccess string `json:"apikeyaccess"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -1219,6 +1220,7 @@ type LdapCreateAccountResponseUser struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` diff --git a/cloudstack/LoadBalancerService.go b/cloudstack/LoadBalancerService.go index b00edccb..8452cf05 100644 --- a/cloudstack/LoadBalancerService.go +++ b/cloudstack/LoadBalancerService.go @@ -5850,6 +5850,7 @@ func (s *LoadBalancerService) StopNetScalerVpx(p *StopNetScalerVpxParams) (*Stop type StopNetScalerVpxResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` diff --git a/cloudstack/ManagementService.go b/cloudstack/ManagementService.go index 2505606d..3619c0f3 100644 --- a/cloudstack/ManagementService.go +++ b/cloudstack/ManagementService.go @@ -143,6 +143,10 @@ func (p *ListManagementServersParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["peers"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("peers", vv) + } return u } @@ -251,6 +255,27 @@ func (p *ListManagementServersParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListManagementServersParams) SetPeers(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["peers"] = v +} + +func (p *ListManagementServersParams) ResetPeers() { + if p.p != nil && p.p["peers"] != nil { + delete(p.p, "peers") + } +} + +func (p *ListManagementServersParams) GetPeers() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["peers"].(bool) + return value, ok +} + // You should always use this function to get a new ListManagementServersParams instance, // as then you are sure you have configured all required params func (s *ManagementService) NewListManagementServersParams() *ListManagementServersParams { @@ -363,20 +388,22 @@ type ListManagementServersResponse struct { } type ManagementServer struct { - Id string `json:"id"` - Javadistribution string `json:"javadistribution"` - Javaversion string `json:"javaversion"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Kernelversion string `json:"kernelversion"` - Lastboottime string `json:"lastboottime"` - Lastserverstart string `json:"lastserverstart"` - Lastserverstop string `json:"lastserverstop"` - Name string `json:"name"` - Osdistribution string `json:"osdistribution"` - Serviceip string `json:"serviceip"` - State string `json:"state"` - Version string `json:"version"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + Javadistribution string `json:"javadistribution"` + Javaversion string `json:"javaversion"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Kernelversion string `json:"kernelversion"` + Lastboottime string `json:"lastboottime"` + Lastserverstart string `json:"lastserverstart"` + Lastserverstop string `json:"lastserverstop"` + Name string `json:"name"` + Osdistribution string `json:"osdistribution"` + Peers []string `json:"peers"` + Serviceip string `json:"serviceip"` + State string `json:"state"` + Version string `json:"version"` } type ListManagementServersMetricsParams struct { @@ -405,6 +432,10 @@ func (p *ListManagementServersMetricsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["peers"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("peers", vv) + } if v, found := p.p["system"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("system", vv) @@ -517,6 +548,27 @@ func (p *ListManagementServersMetricsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListManagementServersMetricsParams) SetPeers(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["peers"] = v +} + +func (p *ListManagementServersMetricsParams) ResetPeers() { + if p.p != nil && p.p["peers"] != nil { + delete(p.p, "peers") + } +} + +func (p *ListManagementServersMetricsParams) GetPeers() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["peers"].(bool) + return value, ok +} + func (p *ListManagementServersMetricsParams) SetSystem(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -658,6 +710,7 @@ type ManagementServersMetric struct { Heapmemorytotal int64 `json:"heapmemorytotal"` Heapmemoryused int64 `json:"heapmemoryused"` Id string `json:"id"` + Ipaddress string `json:"ipaddress"` Javadistribution string `json:"javadistribution"` Javaversion string `json:"javaversion"` JobID string `json:"jobid"` @@ -669,6 +722,7 @@ type ManagementServersMetric struct { Loginfo string `json:"loginfo"` Name string `json:"name"` Osdistribution string `json:"osdistribution"` + Peers []string `json:"peers"` Serviceip string `json:"serviceip"` Sessions int64 `json:"sessions"` State string `json:"state"` diff --git a/cloudstack/NetscalerService.go b/cloudstack/NetscalerService.go index 26dca1ad..dc17de7d 100644 --- a/cloudstack/NetscalerService.go +++ b/cloudstack/NetscalerService.go @@ -1088,6 +1088,7 @@ type NetscalerLoadBalancerNetwork struct { Sentbytes int64 `json:"sentbytes"` Service []NetscalerLoadBalancerNetworkService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 0a80740b..924f1f6f 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -1850,6 +1850,7 @@ type CreateNetworkResponse struct { Sentbytes int64 `json:"sentbytes"` Service []CreateNetworkResponseService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` @@ -4992,6 +4993,7 @@ type Network struct { Sentbytes int64 `json:"sentbytes"` Service []NetworkServiceInternal `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` @@ -5271,6 +5273,7 @@ type NiciraNvpDeviceNetwork struct { Sentbytes int64 `json:"sentbytes"` Service []NiciraNvpDeviceNetworkService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` @@ -5681,6 +5684,7 @@ type PaloAltoFirewallNetwork struct { Sentbytes int64 `json:"sentbytes"` Service []PaloAltoFirewallNetworkService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` @@ -6618,6 +6622,7 @@ type MigrateNetworkResponse struct { Sentbytes int64 `json:"sentbytes"` Service []MigrateNetworkResponseService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` @@ -7491,6 +7496,7 @@ type UpdateNetworkResponse struct { Sentbytes int64 `json:"sentbytes"` Service []UpdateNetworkResponseService `json:"service"` Specifyipranges bool `json:"specifyipranges"` + Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index 608e5690..5c384fd2 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -594,6 +594,7 @@ func (s *NicService) UpdateVmNicIp(p *UpdateVmNicIpParams) (*UpdateVmNicIpRespon type UpdateVmNicIpResponse struct { Account string `json:"account"` Affinitygroup []UpdateVmNicIpResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/PoolService.go b/cloudstack/PoolService.go index 32575397..d074b048 100644 --- a/cloudstack/PoolService.go +++ b/cloudstack/PoolService.go @@ -463,6 +463,7 @@ type CreateStoragePoolResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -751,6 +752,7 @@ type FindStoragePoolsForMigrationResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1325,6 +1327,7 @@ type StoragePool struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1440,6 +1443,7 @@ type SyncStoragePoolResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1735,6 +1739,7 @@ type UpdateStoragePoolResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/RouterService.go b/cloudstack/RouterService.go index 48139f86..9d47790a 100644 --- a/cloudstack/RouterService.go +++ b/cloudstack/RouterService.go @@ -141,6 +141,7 @@ func (s *RouterService) ChangeServiceForRouter(p *ChangeServiceForRouterParams) type ChangeServiceForRouterResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -526,6 +527,7 @@ func (s *RouterService) DestroyRouter(p *DestroyRouterParams) (*DestroyRouterRes type DestroyRouterResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -695,6 +697,9 @@ func (p *ListRoutersParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clusterid"]; found { u.Set("clusterid", v.(string)) } @@ -786,6 +791,27 @@ func (p *ListRoutersParams) GetAccount() (string, bool) { return value, ok } +func (p *ListRoutersParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListRoutersParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListRoutersParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListRoutersParams) SetClusterid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1319,6 +1345,7 @@ type ListRoutersResponse struct { type Router struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -1725,6 +1752,7 @@ func (s *RouterService) RebootRouter(p *RebootRouterParams) (*RebootRouterRespon type RebootRouterResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -1872,6 +1900,7 @@ func (s *RouterService) StartRouter(p *StartRouterParams) (*StartRouterResponse, type StartRouterResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` @@ -2044,6 +2073,7 @@ func (s *RouterService) StopRouter(p *StopRouterParams) (*StopRouterResponse, er type StopRouterResponse struct { Account string `json:"account"` + Arch string `json:"arch"` Created string `json:"created"` Dns1 string `json:"dns1"` Dns2 string `json:"dns2"` diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index 9f9131ee..03c2ec87 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -1144,6 +1144,7 @@ func (s *SSHService) ResetSSHKeyForVirtualMachine(p *ResetSSHKeyForVirtualMachin type ResetSSHKeyForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetSSHKeyForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index edc8d67c..5c0102d7 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -3466,6 +3466,7 @@ func (s *SnapshotService) RevertToVMSnapshot(p *RevertToVMSnapshotParams) (*Reve type RevertToVMSnapshotResponse struct { Account string `json:"account"` Affinitygroup []RevertToVMSnapshotResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/StoragePoolService.go b/cloudstack/StoragePoolService.go index e4df481c..51509343 100644 --- a/cloudstack/StoragePoolService.go +++ b/cloudstack/StoragePoolService.go @@ -171,6 +171,7 @@ type CancelStorageMaintenanceResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -417,6 +418,7 @@ type EnableStorageMaintenanceResponse struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2169,6 +2171,7 @@ type StoragePoolsMetric struct { Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` + Usediops int64 `json:"usediops"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index 85deb30f..f5d5ad25 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -171,6 +171,7 @@ func (s *SystemVMService) ChangeServiceForSystemVm(p *ChangeServiceForSystemVmPa type ChangeServiceForSystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -294,6 +295,7 @@ func (s *SystemVMService) DestroySystemVm(p *DestroySystemVmParams) (*DestroySys type DestroySystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -343,6 +345,9 @@ func (p *ListSystemVmsParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["hostid"]; found { u.Set("hostid", v.(string)) } @@ -381,6 +386,27 @@ func (p *ListSystemVmsParams) toURLValues() url.Values { return u } +func (p *ListSystemVmsParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListSystemVmsParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListSystemVmsParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListSystemVmsParams) SetHostid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -726,6 +752,7 @@ type ListSystemVmsResponse struct { type SystemVm struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -1249,6 +1276,7 @@ func (s *SystemVMService) MigrateSystemVm(p *MigrateSystemVmParams) (*MigrateSys type MigrateSystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -1397,6 +1425,7 @@ func (s *SystemVMService) RebootSystemVm(p *RebootSystemVmParams) (*RebootSystem type RebootSystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -1572,6 +1601,7 @@ func (s *SystemVMService) ScaleSystemVm(p *ScaleSystemVmParams) (*ScaleSystemVmR type ScaleSystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -1695,6 +1725,7 @@ func (s *SystemVMService) StartSystemVm(p *StartSystemVmParams) (*StartSystemVmR type StartSystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` @@ -1843,6 +1874,7 @@ func (s *SystemVMService) StopSystemVm(p *StopSystemVmParams) (*StopSystemVmResp type StopSystemVmResponse struct { Activeviewersessions int `json:"activeviewersessions"` Agentstate string `json:"agentstate"` + Arch string `json:"arch"` Created string `json:"created"` Disconnected string `json:"disconnected"` Dns1 string `json:"dns1"` diff --git a/cloudstack/UserService.go b/cloudstack/UserService.go index a8cd942b..1939ad4f 100644 --- a/cloudstack/UserService.go +++ b/cloudstack/UserService.go @@ -338,6 +338,7 @@ type CreateUserResponse struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -541,6 +542,7 @@ type DisableUserResponse struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -634,6 +636,7 @@ type EnableUserResponse struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -723,6 +726,7 @@ type GetUserResponse struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -812,10 +816,11 @@ func (s *UserService) GetUserKeys(p *GetUserKeysParams) (*GetUserKeysResponse, e } type GetUserKeysResponse struct { - Apikey string `json:"apikey"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Secretkey string `json:"secretkey"` + Apikey string `json:"apikey"` + Apikeyaccess bool `json:"apikeyaccess"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Secretkey string `json:"secretkey"` } type GetVirtualMachineUserDataParams struct { @@ -976,6 +981,9 @@ func (p *ListUsersParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("accounttype", vv) } + if v, found := p.p["apikeyaccess"]; found { + u.Set("apikeyaccess", v.(string)) + } if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } @@ -1056,6 +1064,27 @@ func (p *ListUsersParams) GetAccounttype() (int, bool) { return value, ok } +func (p *ListUsersParams) SetApikeyaccess(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["apikeyaccess"] = v +} + +func (p *ListUsersParams) ResetApikeyaccess() { + if p.p != nil && p.p["apikeyaccess"] != nil { + delete(p.p, "apikeyaccess") + } +} + +func (p *ListUsersParams) GetApikeyaccess() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["apikeyaccess"].(string) + return value, ok +} + func (p *ListUsersParams) SetDomainid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1332,6 +1361,7 @@ type User struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1425,6 +1455,7 @@ type LockUserResponse struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1514,10 +1545,11 @@ func (s *UserService) RegisterUserKeys(p *RegisterUserKeysParams) (*RegisterUser } type RegisterUserKeysResponse struct { - Apikey string `json:"apikey"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Secretkey string `json:"secretkey"` + Apikey string `json:"apikey"` + Apikeyaccess bool `json:"apikeyaccess"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Secretkey string `json:"secretkey"` } type UpdateUserParams struct { @@ -1529,6 +1561,9 @@ func (p *UpdateUserParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["apikeyaccess"]; found { + u.Set("apikeyaccess", v.(string)) + } if v, found := p.p["currentpassword"]; found { u.Set("currentpassword", v.(string)) } @@ -1566,6 +1601,27 @@ func (p *UpdateUserParams) toURLValues() url.Values { return u } +func (p *UpdateUserParams) SetApikeyaccess(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["apikeyaccess"] = v +} + +func (p *UpdateUserParams) ResetApikeyaccess() { + if p.p != nil && p.p["apikeyaccess"] != nil { + delete(p.p, "apikeyaccess") + } +} + +func (p *UpdateUserParams) GetApikeyaccess() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["apikeyaccess"].(string) + return value, ok +} + func (p *UpdateUserParams) SetCurrentpassword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1826,6 +1882,7 @@ type UpdateUserResponse struct { Accountid string `json:"accountid"` Accounttype int `json:"accounttype"` Apikey string `json:"apikey"` + Apikeyaccess string `json:"apikeyaccess"` Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 89176829..9bb79a8d 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -290,6 +290,7 @@ func (s *VirtualMachineService) AddNicToVirtualMachine(p *AddNicToVirtualMachine type AddNicToVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []AddNicToVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -640,6 +641,7 @@ func (s *VirtualMachineService) AssignVirtualMachine(p *AssignVirtualMachinePara type AssignVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []AssignVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -1020,6 +1022,7 @@ func (s *VirtualMachineService) ChangeServiceForVirtualMachine(p *ChangeServiceF type ChangeServiceForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ChangeServiceForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -2639,6 +2642,7 @@ func (s *VirtualMachineService) DeployVirtualMachine(p *DeployVirtualMachinePara type DeployVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []DeployVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -2937,6 +2941,7 @@ func (s *VirtualMachineService) DestroyVirtualMachine(p *DestroyVirtualMachinePa type DestroyVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []DestroyVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -3269,6 +3274,9 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["autoscalevmgroupid"]; found { u.Set("autoscalevmgroupid", v.(string)) } @@ -3388,6 +3396,9 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("userdata", vv) } + if v, found := p.p["userdataid"]; found { + u.Set("userdataid", v.(string)) + } if v, found := p.p["userid"]; found { u.Set("userid", v.(string)) } @@ -3463,6 +3474,27 @@ func (p *ListVirtualMachinesParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListVirtualMachinesParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListVirtualMachinesParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListVirtualMachinesParams) SetAutoscalevmgroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4177,6 +4209,27 @@ func (p *ListVirtualMachinesParams) GetUserdata() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *ListVirtualMachinesParams) ResetUserdataid() { + if p.p != nil && p.p["userdataid"] != nil { + delete(p.p, "userdataid") + } +} + +func (p *ListVirtualMachinesParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + func (p *ListVirtualMachinesParams) SetUserid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4354,6 +4407,7 @@ type ListVirtualMachinesResponse struct { type VirtualMachine struct { Account string `json:"account"` Affinitygroup []VirtualMachineAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -4538,6 +4592,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["autoscalevmgroupid"]; found { u.Set("autoscalevmgroupid", v.(string)) } @@ -4657,6 +4714,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("userdata", vv) } + if v, found := p.p["userdataid"]; found { + u.Set("userdataid", v.(string)) + } if v, found := p.p["userid"]; found { u.Set("userid", v.(string)) } @@ -4732,6 +4792,27 @@ func (p *ListVirtualMachinesMetricsParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListVirtualMachinesMetricsParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListVirtualMachinesMetricsParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetAutoscalevmgroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5446,6 +5527,27 @@ func (p *ListVirtualMachinesMetricsParams) GetUserdata() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) ResetUserdataid() { + if p.p != nil && p.p["userdataid"] != nil { + delete(p.p, "userdataid") + } +} + +func (p *ListVirtualMachinesMetricsParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetUserid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5623,6 +5725,7 @@ type ListVirtualMachinesMetricsResponse struct { type VirtualMachinesMetric struct { Account string `json:"account"` Affinitygroup []VirtualMachinesMetricAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -6033,6 +6136,8 @@ type ListVmsForImportResponse struct { } type VmsForImport struct { + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Cpucorepersocket int `json:"cpucorepersocket"` @@ -6221,6 +6326,7 @@ func (s *VirtualMachineService) MigrateVirtualMachine(p *MigrateVirtualMachinePa type MigrateVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []MigrateVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -6561,6 +6667,7 @@ func (s *VirtualMachineService) MigrateVirtualMachineWithVolume(p *MigrateVirtua type MigrateVirtualMachineWithVolumeResponse struct { Account string `json:"account"` Affinitygroup []MigrateVirtualMachineWithVolumeResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -6859,6 +6966,7 @@ func (s *VirtualMachineService) RebootVirtualMachine(p *RebootVirtualMachinePara type RebootVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RebootVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -7087,6 +7195,7 @@ func (s *VirtualMachineService) RecoverVirtualMachine(p *RecoverVirtualMachinePa type RecoverVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RecoverVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -7360,6 +7469,7 @@ func (s *VirtualMachineService) RemoveNicFromVirtualMachine(p *RemoveNicFromVirt type RemoveNicFromVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RemoveNicFromVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -7632,6 +7742,7 @@ func (s *VirtualMachineService) ResetPasswordForVirtualMachine(p *ResetPasswordF type ResetPasswordForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetPasswordForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -8008,6 +8119,7 @@ func (s *VirtualMachineService) ResetUserDataForVirtualMachine(p *ResetUserDataF type ResetUserDataForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetUserDataForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -8381,6 +8493,7 @@ func (s *VirtualMachineService) RestoreVirtualMachine(p *RestoreVirtualMachinePa type RestoreVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RestoreVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -9009,6 +9122,7 @@ func (s *VirtualMachineService) StartVirtualMachine(p *StartVirtualMachineParams type StartVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []StartVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -9282,6 +9396,7 @@ func (s *VirtualMachineService) StopVirtualMachine(p *StopVirtualMachineParams) type StopVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []StopVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -9555,6 +9670,7 @@ func (s *VirtualMachineService) UpdateDefaultNicForVirtualMachine(p *UpdateDefau type UpdateDefaultNicForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []UpdateDefaultNicForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -10272,6 +10388,7 @@ func (s *VirtualMachineService) UpdateVirtualMachine(p *UpdateVirtualMachinePara type UpdateVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []UpdateVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -10840,6 +10957,9 @@ func (p *ImportVmParams) toURLValues() url.Values { if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } + if v, found := p.p["importinstancehostid"]; found { + u.Set("importinstancehostid", v.(string)) + } if v, found := p.p["importsource"]; found { u.Set("importsource", v.(string)) } @@ -11311,6 +11431,27 @@ func (p *ImportVmParams) GetHypervisor() (string, bool) { return value, ok } +func (p *ImportVmParams) SetImportinstancehostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["importinstancehostid"] = v +} + +func (p *ImportVmParams) ResetImportinstancehostid() { + if p.p != nil && p.p["importinstancehostid"] != nil { + delete(p.p, "importinstancehostid") + } +} + +func (p *ImportVmParams) GetImportinstancehostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["importinstancehostid"].(string) + return value, ok +} + func (p *ImportVmParams) SetImportsource(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -11692,6 +11833,7 @@ func (s *VirtualMachineService) ImportVm(p *ImportVmParams) (*ImportVmResponse, type ImportVmResponse struct { Account string `json:"account"` Affinitygroup []ImportVmResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -12108,6 +12250,8 @@ type ListUnmanagedInstancesResponse struct { } type UnmanagedInstance struct { + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Cpucorepersocket int `json:"cpucorepersocket"` @@ -12578,6 +12722,7 @@ func (s *VirtualMachineService) ImportUnmanagedInstance(p *ImportUnmanagedInstan type ImportUnmanagedInstanceResponse struct { Account string `json:"account"` Affinitygroup []ImportUnmanagedInstanceResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/VirtualNetworkFunctionsService.go b/cloudstack/VirtualNetworkFunctionsService.go index 239900bb..9e73da66 100644 --- a/cloudstack/VirtualNetworkFunctionsService.go +++ b/cloudstack/VirtualNetworkFunctionsService.go @@ -1558,6 +1558,7 @@ func (s *VirtualNetworkFunctionsService) DeployVnfAppliance(p *DeployVnfApplianc type DeployVnfApplianceResponse struct { Account string `json:"account"` Affinitygroup []DeployVnfApplianceResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` @@ -1742,6 +1743,9 @@ func (p *ListVnfAppliancesParams) toURLValues() url.Values { if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["autoscalevmgroupid"]; found { u.Set("autoscalevmgroupid", v.(string)) } @@ -1849,6 +1853,9 @@ func (p *ListVnfAppliancesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("userdata", vv) } + if v, found := p.p["userdataid"]; found { + u.Set("userdataid", v.(string)) + } if v, found := p.p["userid"]; found { u.Set("userid", v.(string)) } @@ -1924,6 +1931,27 @@ func (p *ListVnfAppliancesParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVnfAppliancesParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListVnfAppliancesParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListVnfAppliancesParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListVnfAppliancesParams) SetAutoscalevmgroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2554,6 +2582,27 @@ func (p *ListVnfAppliancesParams) GetUserdata() (bool, bool) { return value, ok } +func (p *ListVnfAppliancesParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *ListVnfAppliancesParams) ResetUserdataid() { + if p.p != nil && p.p["userdataid"] != nil { + delete(p.p, "userdataid") + } +} + +func (p *ListVnfAppliancesParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + func (p *ListVnfAppliancesParams) SetUserid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2731,6 +2780,7 @@ type ListVnfAppliancesResponse struct { type VnfAppliance struct { Account string `json:"account"` Affinitygroup []VnfApplianceAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` Autoscalevmgroupid string `json:"autoscalevmgroupid"` Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index cf6072b6..64447162 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -4920,6 +4920,10 @@ func (p *ResizeVolumeParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["automigrate"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("automigrate", vv) + } if v, found := p.p["diskofferingid"]; found { u.Set("diskofferingid", v.(string)) } @@ -4945,6 +4949,27 @@ func (p *ResizeVolumeParams) toURLValues() url.Values { return u } +func (p *ResizeVolumeParams) SetAutomigrate(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["automigrate"] = v +} + +func (p *ResizeVolumeParams) ResetAutomigrate() { + if p.p != nil && p.p["automigrate"] != nil { + delete(p.p, "automigrate") + } +} + +func (p *ResizeVolumeParams) GetAutomigrate() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["automigrate"].(bool) + return value, ok +} + func (p *ResizeVolumeParams) SetDiskofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/ZoneService.go b/cloudstack/ZoneService.go index af55155d..2e29be1e 100644 --- a/cloudstack/ZoneService.go +++ b/cloudstack/ZoneService.go @@ -711,6 +711,7 @@ type CreateZoneResponse struct { Name string `json:"name"` Networktype string `json:"networktype"` Resourcedetails map[string]string `json:"resourcedetails"` + Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` @@ -2551,6 +2552,7 @@ type Zone struct { Name string `json:"name"` Networktype string `json:"networktype"` Resourcedetails map[string]string `json:"resourcedetails"` + Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` @@ -3042,6 +3044,7 @@ type ZonesMetric struct { Name string `json:"name"` Networktype string `json:"networktype"` Resourcedetails map[string]string `json:"resourcedetails"` + Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` @@ -3725,6 +3728,7 @@ type UpdateZoneResponse struct { Name string `json:"name"` Networktype string `json:"networktype"` Resourcedetails map[string]string `json:"resourcedetails"` + Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` @@ -3764,6 +3768,12 @@ func (p *ListVmwareDcVmsParams) toURLValues() url.Values { if v, found := p.p["existingvcenterid"]; found { u.Set("existingvcenterid", v.(string)) } + if v, found := p.p["hostname"]; found { + u.Set("hostname", v.(string)) + } + if v, found := p.p["instancename"]; found { + u.Set("instancename", v.(string)) + } if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } @@ -3829,6 +3839,48 @@ func (p *ListVmwareDcVmsParams) GetExistingvcenterid() (string, bool) { return value, ok } +func (p *ListVmwareDcVmsParams) SetHostname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostname"] = v +} + +func (p *ListVmwareDcVmsParams) ResetHostname() { + if p.p != nil && p.p["hostname"] != nil { + delete(p.p, "hostname") + } +} + +func (p *ListVmwareDcVmsParams) GetHostname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostname"].(string) + return value, ok +} + +func (p *ListVmwareDcVmsParams) SetInstancename(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["instancename"] = v +} + +func (p *ListVmwareDcVmsParams) ResetInstancename() { + if p.p != nil && p.p["instancename"] != nil { + delete(p.p, "instancename") + } +} + +func (p *ListVmwareDcVmsParams) GetInstancename() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["instancename"].(string) + return value, ok +} + func (p *ListVmwareDcVmsParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3984,6 +4036,8 @@ type ListVmwareDcVmsResponse struct { } type VmwareDcVm struct { + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Cpucorepersocket int `json:"cpucorepersocket"` diff --git a/generate/generate.go b/generate/generate.go index 882c173e..6c43048b 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -2097,8 +2097,19 @@ func (s *service) recusiveGenerateResponseType(aName string, tn string, resp API customMarshal := false found := make(map[string]bool) + // Only apply custom response type name if the current tn is not already a custom type if val, ok := customResponseStructTypes[aName]; ok { - tn = val + // Don't override if tn is already a custom-generated nested type (contains the custom name) + isNestedType := false + for _, customType := range customResponseStructTypes { + if strings.Contains(tn, customType) && tn != customType { + isNestedType = true + break + } + } + if !isNestedType { + tn = val + } } pn("type %s struct {", tn) diff --git a/generate/listApis.json b/generate/listApis.json index 7bd79154..790365cb 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -6,90 +6,90 @@ "name": "createVPCOffering", "params": [ { - "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": "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": "serviceproviderlist", + "name": "internetprotocol", "required": false, - "type": "map" + "since": "4.17.0", + "type": "string" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "fornsx", + "name": "enable", "required": false, - "since": "4.20.0", + "since": "4.16", "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "serviceproviderlist", "required": false, - "type": "list" + "type": "map" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "routingmode", "required": false, - "since": "4.13", - "type": "list" + "since": "4.20.0", + "type": "string" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "true if the VPC offering supports choosing AS number", "length": 255, - "name": "networkmode", + "name": "specifyasnumber", "required": false, "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "internetprotocol", + "name": "networkmode", "required": false, - "since": "4.17.0", + "since": "4.20.0", "type": "string" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "the name of the vpc offering", "length": 255, - "name": "displaytext", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "services supported by the vpc offering", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "supportedservices", + "name": "fornsx", "required": false, - "type": "list" + "since": "4.20.0", + "type": "boolean" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "the ID of the service offering for the VPC router appliance", "length": 255, - "name": "enable", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.16", - "type": "boolean" + "type": "uuid" }, { - "description": "true if the VPC offering supports choosing AS number", + "description": "the display text of the vpc offering, defaults to the 'name'", "length": 255, - "name": "specifyasnumber", + "name": "displaytext", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the service offering for the VPC router appliance", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.13", + "type": "list" }, { "description": "true if network offering for NSX VPC offering supports Load balancer service.", @@ -100,12 +100,19 @@ "type": "boolean" }, { - "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "description": "services supported by the vpc offering", "length": 255, - "name": "routingmode", + "name": "supportedservices", "required": false, - "since": "4.20.0", - "type": "string" + "type": "list" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "list" }, { "description": "desired service capabilities as part of vpc offering", @@ -114,45 +121,34 @@ "required": false, "since": "4.4", "type": "map" - }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, + {}, { "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", "name": "networkmode", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the vpc offering", - "name": "id", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { @@ -161,75 +157,64 @@ "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + {}, { "description": "the internet protocol of the vpc offering", "name": "internetprotocol", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -241,13 +226,13 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -255,6 +240,11 @@ "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "state of the network provider", "name": "state", @@ -262,37 +252,47 @@ } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" } ], "type": "list" }, - {}, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" - }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, - {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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", - "type": "boolean" - }, { "description": "indicated if the offering can support region level vpc", "name": "supportsregionLevelvpc", @@ -306,11 +306,19 @@ "name": "ldapCreateAccount", "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,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { "description": "Creates the user under the specified domain.", @@ -328,31 +336,24 @@ "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Unique username.", "length": 255, - "name": "userid", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "networkdomain", + "name": "userid", "required": false, "type": "string" }, { - "description": "details for account used to store specific parameters", + "description": "Network domain for the account's networks", "length": 255, - "name": "accountdetails", + "name": "networkdomain", "required": false, - "type": "map" - }, - { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, "type": "string" }, { @@ -363,12 +364,11 @@ "type": "integer" }, { - "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,importRole,listRoles,updateRole", + "name": "timezone", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Account UUID, required for adding account from external provisioning system", @@ -381,90 +381,206 @@ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "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 total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "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 ID of the role", + "name": "roleid", + "type": "string" + }, { "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 number of cpu cores the account can own", - "name": "cpulimit", + "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 networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + } + ], + "type": "list" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { "description": "the total number of public ip addresses this account can acquire", @@ -472,34 +588,34 @@ "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "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) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the name of the role", @@ -507,68 +623,74 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { "description": "the total volume which can be used by this account", "name": "volumelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -577,19 +699,14 @@ "type": "boolean" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "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", - "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": "id of the Domain the account belongs to", @@ -597,18 +714,24 @@ "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, + {}, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { @@ -617,202 +740,89 @@ "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, - {}, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "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 network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "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 api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ], + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" } ], "since": "4.2.0" @@ -858,29 +868,44 @@ "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on 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 secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "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 ID of the zone for this template", + "name": "zoneid", + "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": "if root disk template, then ids of the datas disk templates this template owns", @@ -888,24 +913,20 @@ "type": "set" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the date this template was removed", @@ -913,23 +934,75 @@ "type": "date" }, { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the project name of the template", + "name": "project", "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -937,56 +1010,50 @@ "name": "size", "type": "long" }, - {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "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 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": "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 domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "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": "checksum of the template", @@ -994,126 +1061,54 @@ "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 URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "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", + "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", + "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", + "description": "the tag of this template", + "name": "templatetag", "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "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 name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the account id to which the template belongs", @@ -1121,80 +1116,95 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + {}, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, { "description": "the template ID of the parent template if present", "name": "sourcetemplateid", "type": "string" }, - {}, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "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": "CPU Arch of the template", - "name": "arch", + "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": "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": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" } ] }, @@ -1213,27 +1223,27 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "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" } ] }, @@ -1245,16 +1255,16 @@ { "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": "ID of the zone", @@ -1265,11 +1275,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "ID of the storage policy", @@ -1283,61 +1293,64 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool type", + "name": "type", "type": "string" }, - {}, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "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": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, - {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { "description": "the Zone ID of the storage pool", @@ -1345,44 +1358,39 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the 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 storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "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": "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": "the name of the storage pool", @@ -1390,58 +1398,65 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "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": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, + {}, { - "description": "the storage pool type", - "name": "type", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" } ] @@ -1471,28 +1486,28 @@ "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { @@ -1501,48 +1516,53 @@ "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 gateway for the system VM", - "name": "gateway", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "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 state of the system VM", - "name": "state", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { @@ -1551,136 +1571,136 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the state of the system VM", + "name": "state", "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 Pod name for the system VM", - "name": "podname", + "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": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, - {}, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" } ] }, @@ -1690,18 +1710,12 @@ "name": "listDedicatedZones", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -1718,6 +1732,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list dedicated zones by affinity group", "length": 255, @@ -1734,24 +1755,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the zone", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "dedicateZone", "response": [ { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { @@ -1759,16 +1774,22 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the ID of the Zone", "name": "zoneid", "type": "string" }, + { + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" }, { "description": "the ID of the dedicated resource", @@ -1776,16 +1797,15 @@ "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" - }, - {} + } ] }, { @@ -1804,18 +1824,18 @@ "related": "", "response": [ { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the current available space of the pool", + "name": "size", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "controller of the pool", + "name": "controllerid", + "type": "string" }, { - "description": "the current available space of the pool", - "name": "size", + "description": "available iops of the pool", + "name": "maxiops", "type": "long" }, { @@ -1824,32 +1844,32 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the storage pool", + "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 storage pool", "name": "id", "type": "string" }, { - "description": "controller of the pool", - "name": "controllerid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" - }, - {}, - {} + } ] }, { @@ -1876,10 +1896,14 @@ ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "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": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -1888,19 +1912,14 @@ "type": "date" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { "description": "id of zone to which the bgp peer belongs to.", @@ -1908,34 +1927,24 @@ "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, + {}, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { @@ -1943,20 +1952,31 @@ "name": "password", "type": "string" }, + {}, { "description": "name of zone to which the bgp peer belongs to.", "name": "zonename", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "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 project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" } ], "since": "4.20.0" @@ -1966,86 +1986,88 @@ "isasync": false, "name": "listTungstenFabricLBHealthMonitor", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the ID of lb rule", "length": 255, "name": "lbruleid", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", "required": true, "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ + { + "description": "the health monitor ID", + "name": "id", + "type": "long" + }, + {}, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "the health monitor expected code", - "name": "expectedcode", - "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" }, { - "description": "the health monitor type", - "name": "type", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, + {}, { - "description": "the health monitor timeout", - "name": "timeout", + "description": "the health monitor interval", + "name": "interval", "type": "int" }, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" - }, - { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "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": "the health monitor type", + "name": "type", "type": "string" }, { @@ -2054,22 +2076,20 @@ "type": "integer" }, { - "description": "the health monitor UUID", - "name": "uuid", - "type": "string" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, - {}, { "description": "the health monitor http method", "name": "httpmethod", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {} + "description": "the health monitor url path", + "name": "urlpath", + "type": "string" + } ] }, { @@ -2094,6 +2114,12 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -2104,18 +2130,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -2124,6 +2144,20 @@ "isasync": true, "name": "updateGuestOs", "params": [ + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": true, + "type": "string" + }, { "description": "UUID of the Guest OS", "length": 255, @@ -2138,33 +2172,24 @@ "name": "forDisplay", "required": false, "type": "boolean" - }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, - "type": "string" } ], "related": "listOsTypes,addGuestOs", "response": [ { - "description": "the name/description of the OS type", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", - "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 category", @@ -2172,37 +2197,32 @@ "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, - {}, { "description": "the name of the OS type", "name": "name", "type": "string" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - } + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -2212,48 +2232,41 @@ "name": "listGuestVlans", "params": [ { - "description": "list guest vlan by physical network", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list guest vlan by vnet", + "description": "list guest vlan by physical network", "length": 255, - "name": "vnet", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list guest vlan by id", + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "id", + "name": "allocatedonly", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list guest vlan by vnet", "length": 255, - "name": "keyword", + "name": "vnet", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list guest vlan by zone", "length": 255, @@ -2263,75 +2276,82 @@ "type": "uuid" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "list guest vlan by id", "length": 255, - "name": "allocatedonly", + "name": "id", "required": false, - "type": "boolean" + "type": "long" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", + "type": "string" }, { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" + }, + { + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" - }, - { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, {}, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", - "type": "string" + "description": "the guest VLAN id", + "name": "id", + "type": "long" }, { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { @@ -2340,29 +2360,29 @@ "type": "integer" }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the project name of the guest VLAN range", + "name": "project", "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 physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "type": "string" } ], "since": "4.17.0" @@ -2372,6 +2392,14 @@ "isasync": false, "name": "updateResourceLimit", "params": [ + { + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, { "description": "Update resource limits for project", "length": 255, @@ -2381,11 +2409,11 @@ "type": "uuid" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": " Maximum resource limit.", "length": 255, - "name": "account", + "name": "max", "required": false, - "type": "string" + "type": "long" }, { "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", @@ -2395,49 +2423,42 @@ "required": false, "type": "uuid" }, - { - "description": "Tag for the resource type", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", - "type": "string" - }, - { - "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, "name": "resourcetype", "required": true, "type": "integer" + }, + { + "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "listResourceLimits", "response": [ { - "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", + "type": "string" }, + {}, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, { @@ -2446,13 +2467,8 @@ "type": "long" }, { - "description": "The tag for the resource limit", - "name": "tag", - "type": "string" - }, - { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -2465,22 +2481,26 @@ "name": "project", "type": "string" }, - {}, - {}, + { + "description": "the domain ID of the resource limit", + "name": "domainid", + "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -2499,16 +2519,10 @@ } ], "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", @@ -2516,9 +2530,15 @@ "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" }, {} ] @@ -2539,6 +2559,11 @@ ], "related": "", "response": [ + { + "description": "crt", + "name": "crt", + "type": "string" + }, { "description": "key", "name": "key", @@ -2550,17 +2575,12 @@ "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "crt", - "name": "crt", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -2584,27 +2604,27 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -2613,11 +2633,12 @@ "name": "startRollingMaintenance", "params": [ { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "timeout", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "list" }, { "description": "the IDs of the zones to start maintenance on", @@ -2628,46 +2649,50 @@ "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "payload", "required": false, - "type": "list" + "type": "string" }, { - "description": "if rolling mechanism should continue in case of an error", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "forced", + "name": "hostids", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "payload", + "name": "timeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "list" }, { - "description": "the IDs of the pods to start maintenance on", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "podids", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" } ], "related": "", "response": [ + { + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" + }, {}, { "description": "the hosts updated", @@ -2679,13 +2704,13 @@ "type": "string" }, { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "the name of the updated host", + "name": "hostname", "type": "string" }, { @@ -2694,22 +2719,18 @@ "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "output of the maintenance script on the host", + "name": "output", "type": "string" } ], "type": "list" }, + {}, { - "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" }, { "description": "the hosts skipped", @@ -2733,17 +2754,16 @@ ], "type": "list" }, + { + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ] }, { @@ -2752,85 +2772,85 @@ "name": "listTungstenFabricApplicationPolicySet", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "List by keyword", "length": 255, - "name": "applicationpolicysetuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "pagesize", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createTungstenFabricApplicationPolicySet", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, + {}, + { + "description": "list Tungsten-Fabric 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": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -2840,12 +2860,11 @@ "name": "updateNetworkACLList", "params": [ { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "Description of the network ACL list", "length": 255, - "name": "fordisplay", + "name": "description", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "the ID of the network ACL", @@ -2864,16 +2883,17 @@ "type": "string" }, { - "description": "Name of the network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Description of the network ACL list", + "description": "Name of the network ACL list", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" } @@ -2884,22 +2904,22 @@ "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, {} ], "since": "4.4" @@ -2910,12 +2930,20 @@ "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": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { "description": "Override root volume's diskoffering.", @@ -2927,20 +2955,20 @@ "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": "Virtual Machine ID", + "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": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "rootdisksize", + "required": false, + "since": "4.19.1", + "type": "long" }, { "description": "Optional field to expunge old root volume after restore.", @@ -2949,485 +2977,128 @@ "required": false, "since": "4.19.1", "type": "boolean" - }, - { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "type": "uuid" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the 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": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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 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 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 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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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": "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" - } - ], - "type": "set" - }, - { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "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": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "User VM type", - "name": "vmtype", + "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", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the virtual machine", + "name": "id", "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -3435,24 +3106,30 @@ "name": "diskkbsread", "type": "long" }, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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", + "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" }, { @@ -3461,58 +3138,49 @@ "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "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", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -3521,63 +3189,48 @@ "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - {}, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, + {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the 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 id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -3586,56 +3239,56 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "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", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -3643,63 +3296,98 @@ "name": "memory", "type": "integer" }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "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 description of the affinity group", - "name": "description", + "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": "dedicated resources associated with this affinity group", "name": "dedicatedresources", "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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 name of the affinity group", - "name": "name", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -3711,78 +3399,148 @@ "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "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", + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "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 disk 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 pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the type of the nic", "name": "type", "type": "string" }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the traffic type of the nic", "name": "traffictype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { "description": "the isolated private VLAN type if available", @@ -3790,48 +3548,48 @@ "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 gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "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", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -3840,38 +3598,38 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the 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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -3880,111 +3638,46 @@ "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" } ], "type": "set" }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "OS name of the vm", "name": "osdisplayname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -3993,39 +3686,376 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "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 ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "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" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "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 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": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "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 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 project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "the name of userdata used for the VM", @@ -4033,23 +4063,18 @@ "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" } ], @@ -4070,12 +4095,17 @@ } ], "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", @@ -4083,15 +4113,48 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "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 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" + }, + {} ] }, { @@ -4107,13 +4170,6 @@ "required": true, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -4127,27 +4183,18 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "associateUcsProfileToBlade", "response": [ - { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "associated ucs profile dn", "name": "profiledn", @@ -4158,51 +4205,29 @@ "name": "id", "type": "string" }, - { - "description": "cloudstack host id this blade associates to", - "name": "hostid", - "type": "string" - }, { "description": "ucs blade dn", "name": "bladedn", "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 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": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, {} @@ -4223,17 +4248,17 @@ ], "related": "getVolumeiScsiName", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -4248,33 +4273,34 @@ "name": "updateHost", "params": [ { - "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 Os category to update the host with", "length": 255, - "name": "allocationstate", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "list of tags to be added to the host", "length": 255, - "name": "istagarule", + "name": "hosttags", "required": false, - "type": "boolean" + "type": "list" }, { "description": "the ID of the host to update", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": true, "type": "uuid" }, { - "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" }, { @@ -4285,39 +4311,43 @@ "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "hosttags", + "name": "istagarule", "required": false, - "type": "list" + "type": "boolean" }, { - "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": "the id of Os category to update the host with", + "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": "oscategoryid", - "related": "listOsCategories", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "response": [ { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -4326,215 +4356,258 @@ "type": "date" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "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", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "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 ID of the host", - "name": "id", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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 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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "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 X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum 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": "capabilities of the host", "name": "capabilities", "type": "string" }, - {}, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the host", + "name": "id", + "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 last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + {}, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "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 cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, - {}, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { @@ -4543,163 +4616,115 @@ "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum 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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "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 ID of the host", - "name": "oscategoryid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "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": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "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", - "name": "cpuallocated", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "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": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the name of the host", + "name": "name", "type": "string" }, + {}, { - "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": "the name of the host", - "name": "name", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "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": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" } ] }, @@ -4716,40 +4741,41 @@ "type": "integer" }, { - "description": "type of the icmp message being sent", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "the ending 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": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "error code for this icmp message", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "icmpcode", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "error code for this icmp message", "length": 255, - "name": "destcidrlist", + "name": "icmpcode", "required": false, - "type": "list" + "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { "description": "type of firewallrule: system/user", @@ -4759,172 +4785,171 @@ "type": "string" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "the ending port of firewall rule", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "cidrlist", + "name": "destcidrlist", "required": false, "type": "list" }, { - "description": "the network id of the port forwarding rule", + "description": "type of the icmp message being sent", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "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" - }, - { - "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": "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 ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, - {}, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 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": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "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 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": "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 cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" } ] @@ -4934,14 +4959,6 @@ "isasync": false, "name": "listSecurityGroups", "params": [ - { - "description": "lists security groups by virtual machine id", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -4951,18 +4968,20 @@ "type": "uuid" }, { - "description": "lists security groups by name", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "securitygroupname", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list the security group by the id provided", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -4972,9 +4991,16 @@ "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 security groups by name", "length": 255, - "name": "listall", + "name": "securitygroupname", + "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" }, @@ -4987,58 +5013,58 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "list the security group by the id provided", + "description": "", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list 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": "", + "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": "createSecurityGroup,updateSecurityGroup", "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, + {}, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -5049,23 +5075,23 @@ "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 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": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -5073,16 +5099,6 @@ "name": "value", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", @@ -5094,27 +5110,37 @@ "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", "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", + "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": "security group name", @@ -5122,25 +5148,15 @@ "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", "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 type of the ICMP message response", "name": "icmptype", @@ -5149,105 +5165,116 @@ ], "type": "set" }, + {}, { - "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "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" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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" } ], "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -5256,25 +5283,45 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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": "security group name", + "name": "securitygroupname", "type": "string" } ], "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 project id of the group", + "name": "projectid", + "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 key name", + "name": "key", "type": "string" }, { @@ -5283,78 +5330,66 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the 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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -5363,19 +5398,9 @@ "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 domain name of the security group", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -5385,119 +5410,120 @@ ] }, { - "description": "Enables a role", + "description": "List OAuth providers registered", "isasync": false, - "name": "enableRole", + "name": "listOauthProvider", "params": [ { - "description": "ID of the role", + "description": "the ID of the OAuth provider", "length": 255, "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "required": false, "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "List OAuth providers registered", - "isasync": false, - "name": "listOauthProvider", - "params": [ + }, { "description": "", "length": 255, "name": "page", "required": false, "type": "integer" - }, + } + ], + "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", + "response": [ { - "description": "the ID of the OAuth provider", - "length": 255, + "description": "ID of the provider", "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "Name of the provider", - "length": 255, "name": "provider", - "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", - "response": [ { "description": "Name of the provider", "name": "name", "type": "string" }, + {}, { - "description": "Name of the provider", - "name": "provider", + "description": "Description of the provider registered", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, + {}, { "description": "Whether the OAuth provider is enabled or not", "name": "enabled", "type": "boolean" }, { - "description": "ID of the provider", - "name": "id", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Enables a role", + "isasync": false, + "name": "enableRole", + "params": [ { - "description": "Description of the provider registered", - "name": "description", - "type": "string" - }, + "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", @@ -5505,23 +5531,22 @@ "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "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" + "since": "4.20.0" }, { "description": "Delete Service Package", @@ -5540,25 +5565,25 @@ "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": "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" } ] }, @@ -5576,16 +5601,16 @@ "type": "uuid" }, { - "description": "the description for the shared filesystem.", + "description": "the name of the shared filesystem.", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" }, { - "description": "the name of the shared filesystem.", + "description": "the description for the shared filesystem.", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" } @@ -5593,23 +5618,13 @@ "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { @@ -5617,212 +5632,54 @@ "name": "filesystem", "type": "string" }, - {}, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "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 shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "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": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "the 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 traffic type of the nic", @@ -5830,33 +5687,23 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "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": "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 IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -5870,9 +5717,9 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "the ID of the nic", @@ -5880,19 +5727,19 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -5900,13 +5747,18 @@ "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -5915,71 +5767,139 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "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 IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { "description": "public IP address id associated with this nic via Static nat rule", "name": "publicipid", "type": "string" + } + ], + "type": "list" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + {}, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -5988,24 +5908,28 @@ "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, - {}, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6013,19 +5937,120 @@ "name": "iscustomdiskoffering", "type": "boolean" }, + {}, { "description": "service offering ID for the shared filesystem", "name": "serviceofferingid", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "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": "the domain associated with the shared filesystem", - "name": "domain", + "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": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" } ], @@ -6054,16 +6079,6 @@ ], "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ - { - "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": "guest IPv4 subnet", @@ -6071,13 +6086,18 @@ "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { @@ -6085,35 +6105,40 @@ "name": "created", "type": "date" }, - {}, { - "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", + "type": "string" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "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": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" } ], @@ -6136,34 +6161,39 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "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 private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { "description": "the ID of the service offering of the system virtual machine.", @@ -6171,64 +6201,74 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, - {}, { "description": "the hostname for the system VM", "name": "hostname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -6237,33 +6277,43 @@ "type": "date" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -6277,28 +6327,29 @@ "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, + {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { @@ -6307,8 +6358,8 @@ "type": "boolean" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6317,36 +6368,15 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the link local netmask for the system vm", "name": "linklocalnetmask", "type": "string" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - {} + } ] }, { @@ -6355,12 +6385,11 @@ "name": "archiveEvents", "params": [ { - "description": "the IDs of the events", + "description": "archive by event type", "length": 255, - "name": "ids", - "related": "listEvents", + "name": "type", "required": false, - "type": "list" + "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\")", @@ -6370,11 +6399,12 @@ "type": "date" }, { - "description": "archive by event type", + "description": "the IDs of the events", "length": 255, - "name": "type", + "name": "ids", + "related": "listEvents", "required": false, - "type": "string" + "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\")", @@ -6385,6 +6415,12 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -6400,12 +6436,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, {} ] }, @@ -6414,6 +6444,14 @@ "isasync": false, "name": "listASNumbers", "params": [ + { + "description": "domain id", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "the vpc id", "length": 255, @@ -6431,20 +6469,18 @@ "type": "integer" }, { - "description": "the AS Number range ID", + "description": "", "length": 255, - "name": "asnrangeid", - "related": "createASNRange,listASNRanges", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the zone ID", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -6454,39 +6490,26 @@ "type": "integer" }, { - "description": "to indicate if the AS number is allocated to any network", - "length": 255, - "name": "isallocated", - "required": false, - "type": "boolean" - }, - { - "description": "account name", - "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the AS Number range ID", "length": 255, - "name": "pagesize", + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "domain id", + "description": "the zone ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "account name", "length": 255, - "name": "keyword", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "string" }, @@ -6497,28 +6520,30 @@ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" + }, + { + "description": "to indicate if the AS number is allocated to any network", + "length": 255, + "name": "isallocated", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Domain ID", - "name": "domainid", + "description": "AS Number ID", + "name": "asnrangeid", "type": "string" }, { - "description": "AS Number ID", - "name": "asnrangeid", + "description": "VPC ID", + "name": "vpcid", "type": "string" }, { - "description": "Network ID", - "name": "associatednetworkid", + "description": "the account name", + "name": "account", "type": "string" }, { @@ -6532,42 +6557,42 @@ "type": "long" }, { - "description": "the domain name", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Domain ID", + "name": "domainid", "type": "string" }, { - "description": "the zone name of the AS Number range", - "name": "zonename", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, - {}, { - "description": "VPC ID", - "name": "vpcid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, + {}, + {}, { "description": "Allocated Date", "name": "allocated", "type": "date" }, { - "description": "the account name", - "name": "account", - "type": "string" - }, - { - "description": "Zone ID", - "name": "zoneid", + "description": "Network ID", + "name": "associatednetworkid", "type": "string" }, { - "description": "Network Name", - "name": "associatednetworkname", + "description": "ID of the AS Number", + "name": "id", "type": "string" }, - {}, { "description": "Account ID", "name": "accountid", @@ -6579,24 +6604,29 @@ "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the zone name of the AS Number range", + "name": "zonename", "type": "string" }, { - "description": "Allocation state", - "name": "allocationstate", + "description": "Network Name", + "name": "associatednetworkname", "type": "string" }, { - "description": "ID of the AS Number", - "name": "id", + "description": "the domain name", + "name": "domain", "type": "string" }, { "description": "VPC Name", "name": "vpcname", "type": "string" + }, + { + "description": "Allocation state", + "name": "allocationstate", + "type": "string" } ], "since": "4.20.0" @@ -6617,14 +6647,9 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -6633,11 +6658,16 @@ "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.2.0" }, @@ -6647,11 +6677,11 @@ "name": "listUserData", "params": [ { - "description": "Userdata name to look for", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -6661,20 +6691,18 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List by keyword", @@ -6684,57 +6712,54 @@ "type": "string" }, { - "description": "the ID of the Userdata", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listUserData", + "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,updateDomain,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list 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": "", + "description": "Userdata name to look for", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the Userdata", "length": 255, - "name": "account", + "name": "id", + "related": "listUserData", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the project id of the userdata", - "name": "projectid", + "description": "the domain name of the userdata owner", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Name of the userdata", - "name": "name", + "description": "base64 encoded userdata content", + "name": "userdata", "type": "string" }, { @@ -6742,26 +6767,22 @@ "name": "accountid", "type": "string" }, + {}, { - "description": "the domain name of the userdata owner", - "name": "domain", + "description": "path of the domain to which the userdata owner belongs", + "name": "domainpath", "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 userdata owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the userdata owner belongs", - "name": "domainpath", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "ID of the ssh keypair", @@ -6769,14 +6790,13 @@ "type": "string" }, { - "description": "the project name of the userdata", - "name": "project", + "description": "the owner of the userdata", + "name": "account", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the userdata", + "name": "project", "type": "string" }, { @@ -6785,13 +6805,23 @@ "type": "string" }, { - "description": "the owner of the userdata", - "name": "account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "base64 encoded userdata content", - "name": "userdata", + "description": "Name of the userdata", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the userdata", + "name": "projectid", "type": "string" } ], @@ -6814,7 +6844,7 @@ "description": "the ID of the load balancer", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", "required": true, "type": "uuid" }, @@ -6830,23 +6860,45 @@ "related": "createLoadBalancer,listLoadBalancers", "response": [ { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the description of the Load Balancer", - "name": "description", + "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 account of the Load Balancer", - "name": "account", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { @@ -6859,23 +6911,18 @@ "name": "domainid", "type": "string" }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { @@ -6884,27 +6931,22 @@ "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the instance ID", + "name": "id", "type": "string" } ], "type": "list" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, {}, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6913,25 +6955,19 @@ "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "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 list of resource tags associated with the Load Balancer", "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 domain associated with the tag", "name": "domain", @@ -6943,8 +6979,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" }, { @@ -6953,18 +6989,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "tag key name", + "name": "key", "type": "string" }, { @@ -6973,54 +7014,43 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", - "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 account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", + "type": "string" } ], "since": "4.4.0" @@ -7057,23 +7087,28 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -7081,55 +7116,44 @@ "name": "linklocalip", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the host ID for the system VM", "name": "hostid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { @@ -7137,136 +7161,147 @@ "name": "podid", "type": "string" }, + {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "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 template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "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 public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, - {}, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "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 first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" + }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" } ] }, @@ -7275,6 +7310,13 @@ "isasync": false, "name": "verifyOAuthCodeAndGetUser", "params": [ + { + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -7283,10 +7325,10 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Name of the provider", "length": 255, - "name": "keyword", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { @@ -7297,74 +7339,67 @@ "type": "integer" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "List by keyword", "length": 255, - "name": "secretcode", + "name": "keyword", "required": false, "type": "string" - }, - { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" } ], "related": "updateOauthProvider", "response": [ + { + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" + }, {}, { - "description": "ID of the provider", - "name": "id", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "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", + "name": "enabled", + "type": "boolean" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", - "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": "name", "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": "Description of the provider registered", - "name": "description", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" - }, - {} + } ], "since": "4.19.0" }, @@ -7376,14 +7411,22 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -7401,60 +7444,52 @@ "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, "type": "uuid" - }, - { - "description": "ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" } ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, - { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, {}, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "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", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, + {}, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "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": "unique ID of the drs plan for cluster", + "name": "id", + "type": "string" + }, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" } ], "since": "4.19.0" @@ -7465,33 +7500,33 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by the cluster ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by the cluster name", "length": 255, - "name": "clustertype", + "name": "name", "required": false, "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "hypervisor", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "", + "description": "lists clusters by Zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "lists clusters by allocation state", @@ -7501,12 +7536,11 @@ "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -7516,83 +7550,78 @@ "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "CPU arch of the clusters", "length": 255, - "name": "managedstate", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists clusters by Zone ID", + "description": "lists clusters by cluster type", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clustertype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" } ], "related": "addCluster,updateCluster", "response": [ - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Zone name of the cluster", "name": "zonename", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the Pod ID of the cluster", @@ -7600,40 +7629,34 @@ "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, - {}, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", "type": "map" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, + {}, { - "description": "the cluster ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -7641,13 +7664,18 @@ "name": "capacity", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -7656,13 +7684,13 @@ "type": "short" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -7670,30 +7698,25 @@ "name": "tag", "type": "string" }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the capacity currently in allocated", @@ -7701,22 +7724,42 @@ "type": "long" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" } ], "type": "list" }, { - "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": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" }, { "description": "the hypervisor type of the cluster", "name": "hypervisortype", "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" } ] }, @@ -7726,63 +7769,55 @@ "name": "listProjectInvitations", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "list invitation by user ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "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.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list invitations by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list invitation by user ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list by project id", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by project 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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list invitations by id", @@ -7793,18 +7828,19 @@ "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": "", + "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 true, list only active invitations - having Pending state and ones that are not timed out yet", @@ -7812,34 +7848,42 @@ "name": "activeonly", "required": false, "type": "boolean" + }, + { + "description": "list invitations by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the invitation state", - "name": "state", + "description": "the User ID", + "name": "userid", "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the id of the invitation", + "name": "id", "type": "string" }, {}, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the email the invitation was sent to", + "name": "email", "type": "string" }, { @@ -7848,35 +7892,34 @@ "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 email the invitation was sent to", - "name": "email", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the project", + "name": "project", + "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, - {}, { - "description": "the id of the invitation", - "name": "id", + "description": "the invitation state", + "name": "state", "type": "string" }, { - "description": "path of the Domain the project belongs to", - "name": "domainpath", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" @@ -7886,6 +7929,13 @@ "isasync": false, "name": "listEgressFirewallRules", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of IP address of the firewall services", "length": 255, @@ -7895,45 +7945,54 @@ "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { "description": "Lists rule with the specified ID.", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, @@ -7946,54 +8005,38 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "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 account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "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": "uuid" + "type": "map" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { @@ -8002,23 +8045,29 @@ "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "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 protocol of the firewall rule", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -8026,13 +8075,8 @@ "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -8046,13 +8090,23 @@ "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -8061,73 +8115,62 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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": "list" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", + "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": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, - {}, { "description": "the 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the 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" } ] @@ -8138,163 +8181,191 @@ "name": "listClustersMetrics", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists clusters by the cluster name", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "lists clusters by cluster type", "length": 255, - "name": "allocationstate", + "name": "clustertype", "required": false, "type": "string" }, { - "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 Zone ID", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists clusters by Pod ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "lists clusters by allocation state", "length": 255, - "name": "pagesize", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Pod ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by Zone ID", "length": 255, - "name": "clustertype", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "CPU arch of the clusters", "length": 255, - "name": "managedstate", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" } ], "related": "", "response": [ { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, { "description": "the Pod ID of the cluster", "name": "podid", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", "type": "string" }, { @@ -8302,15 +8373,30 @@ "name": "name", "type": "string" }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, { "description": "the allocation state of the cluster", "name": "allocationstate", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" }, { "description": "the capacity of the Cluster", @@ -8322,8 +8408,8 @@ "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -8331,49 +8417,49 @@ "name": "capacityused", "type": "long" }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, { "description": "the Cluster ID", "name": "clusterid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -8385,39 +8471,36 @@ "type": "list" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" }, + {}, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "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": "cpu usage notification threshold exceeded", @@ -8425,66 +8508,34 @@ "type": "boolean" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { "description": "memory allocated notification threshold exceeded", "name": "memoryallocatedthreshold", "type": "boolean" - }, - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" } ], "since": "4.9.3" @@ -8494,13 +8545,6 @@ "isasync": false, "name": "listStoragePoolObjects", "params": [ - { - "description": "path to list on storage pool", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -8515,13 +8559,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "id of the storage pool", "length": 255, @@ -8529,31 +8566,54 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" + }, + { + "description": "path to list on storage pool", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "listImageStoreObjects", "response": [ { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", - "type": "string" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { "description": "Name of the data store object.", "name": "name", "type": "string" }, + { + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "Volume Name associated with the data store object.", + "name": "volumename", + "type": "string" + }, { "description": "Size is in Bytes.", "name": "size", "type": "long" }, - {}, { "description": "Snapshot ID associated with the data store object.", "name": "snapshotid", @@ -8561,28 +8621,79 @@ }, {}, { - "description": "Is it a directory.", - "name": "isdirectory", - "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": "Volume ID associated with the data store object.", "name": "volumeid", "type": "string" }, + {}, + { + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" + }, { "description": "Template Name associated with the data store object.", "name": "templatename", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates a user-defined VM backup schedule", + "isasync": false, + "name": "createBackupSchedule", + "params": [ + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, + "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "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": "ID of the VM for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "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" + } + ], + "related": "updateBackupSchedule,listBackups", + "response": [ + { + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { @@ -8590,9 +8701,91 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "ID of the VM backup", + "name": "id", + "type": "string" + }, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "zone id", + "name": "zoneid", + "type": "string" + }, + { + "description": "backup date", + "name": "created", + "type": "date" + }, + { + "description": "backup type", + "name": "type", + "type": "string" + }, + {}, + { + "description": "domain id", + "name": "domainid", + "type": "string" + }, + { + "description": "zone name", + "name": "zone", + "type": "string" + }, + { + "description": "account id", + "name": "accountid", + "type": "string" + }, + { + "description": "backup offering name", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "account name", + "name": "account", + "type": "string" + }, + { + "description": "external backup id", + "name": "externalid", + "type": "string" + }, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "backed up volumes", + "name": "volumes", + "type": "string" + }, + { + "description": "backup size in bytes", + "name": "size", + "type": "long" + }, + { + "description": "domain name", + "name": "domain", + "type": "string" + }, + { + "description": "backup status", + "name": "status", + "type": "status" + }, + { + "description": "backup offering id", + "name": "backupofferingid", "type": "string" }, { @@ -8601,7 +8794,7 @@ "type": "string" } ], - "since": "4.19.0" + "since": "4.14.0" }, { "description": "Lists secondary staging stores.", @@ -8609,101 +8802,107 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the name of the staging store", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Zone ID for the staging store", + "description": "the ID of the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the staging store protocol", + "description": "the name of the staging store", "length": 255, - "name": "protocol", + "name": "name", "required": false, "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": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the staging store provider", + "description": "the Zone ID for the staging store", "length": 255, - "name": "provider", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the staging store", + "description": "the staging store provider", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, {}, + {}, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "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 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 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 protocol of the image store", @@ -8711,34 +8910,28 @@ "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": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the url of the image store", + "name": "url", "type": "string" } ], @@ -8761,8 +8954,8 @@ "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -8771,119 +8964,98 @@ "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the name of the router", - "name": "name", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the account associated with the router", + "name": "account", "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": "the host ID for the router", - "name": "hostid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -8891,19 +9063,10 @@ "name": "ip6dns1", "type": "string" }, + {}, { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { @@ -8912,8 +9075,8 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -8922,38 +9085,39 @@ "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, + {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the 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 Pod name for the router", - "name": "podname", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { @@ -8961,14 +9125,14 @@ "name": "nic", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "public IP address id associated with this nic via Static nat rule", @@ -8976,23 +9140,33 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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" }, { @@ -9001,23 +9175,23 @@ "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the 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": "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 corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -9026,53 +9200,43 @@ "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -9081,56 +9245,56 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { @@ -9139,44 +9303,59 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", "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 name of the health check on the router", "name": "checkname", @@ -9191,40 +9370,59 @@ "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": "result of the health check", + "name": "success", + "type": "boolean" } ], "type": "list" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { "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" } ] }, @@ -9234,18 +9432,18 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "description": "the ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, @@ -9258,10 +9456,18 @@ "type": "uuid" }, { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, @@ -9279,47 +9485,28 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "the ID of the Account to reset the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "the name of the configuration", - "name": "name", - "type": "string" - }, - { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { @@ -9327,16 +9514,6 @@ "name": "group", "type": "string" }, - { - "description": "the description of the configuration", - "name": "description", - "type": "string" - }, - { - "description": "the subgroup of the configuration", - "name": "subgroup", - "type": "string" - }, { "description": "the value of the configuration", "name": "id", @@ -9353,30 +9530,51 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the name of the configuration", + "name": "name", "type": "string" }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, { "description": "the name of the parent configuration", "name": "parent", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" }, {}, + {}, { - "description": "the value of the configuration", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.16.0" @@ -9387,95 +9585,90 @@ "name": "createAutoScalePolicy", "params": [ { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "quiettime", - "required": false, + "name": "duration", + "required": true, "type": "integer" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "the name of the autoscale policy", "length": 255, - "name": "action", - "required": true, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", + "name": "action", "required": true, - "type": "list" + "type": "string" }, { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "duration", - "required": true, + "name": "quiettime", + "required": false, "type": "integer" }, { - "description": "the name of the autoscale policy", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" } ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ - { - "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 list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, + {}, { "description": "the account owning the autoscale policy", "name": "account", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, {}, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, - {}, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { @@ -9484,19 +9677,24 @@ "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { "description": "the project name of the autoscale policy", "name": "project", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -9509,7 +9707,7 @@ "description": "the host ID of ssp server", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -9517,25 +9715,25 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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" } ] }, @@ -9546,17 +9744,10 @@ "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 name of the active usage server", + "name": "hostname", + "type": "string" }, { "description": "the last time a usage job successfully completed", @@ -9564,14 +9755,14 @@ "type": "date" }, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the active usage server", - "name": "hostname", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { "description": "the state of the usage server", @@ -9582,6 +9773,13 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + {}, + { + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" } ], "since": "4.17.0" @@ -9602,11 +9800,7 @@ ], "response": [ {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -9617,7 +9811,11 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -9632,140 +9830,170 @@ "name": "cleanVMReservations", "params": [], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates Routing firewall rule with specified ID", - "isasync": true, - "name": "updateRoutingFirewallRule", + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", "params": [ { - "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the Routing firewall rule", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the storage pool", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "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": "the name of the object store", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" - } - ], - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "response": [ + }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the object store provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" - }, + } + ], + "related": "addObjectStoragePool,updateObjectStoragePool", + "response": [ {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, + {}, { - "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 VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "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 public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the name of the object store", + "name": "name", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", + "params": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "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 protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "the ID of the Routing firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "required": true, + "type": "uuid" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, + "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" + } + ], + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "response": [ { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -9773,8 +10001,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -9783,23 +10011,23 @@ "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 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": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -9808,142 +10036,112 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", - "params": [ + }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", - "required": false, - "type": "uuid" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "the name of the object store", - "length": 255, - "name": "name", - "required": false, + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the object store provider", - "length": 255, - "name": "provider", - "required": false, + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" - } - ], - "related": "addObjectStoragePool,updateObjectStoragePool", - "response": [ - {}, + }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the name of the object store", - "name": "name", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the url of the object store", - "name": "url", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, + {}, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, + {}, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], - "since": "4.19.0" + "since": "4.20.0" }, { "description": "create secondary staging store.", @@ -9951,19 +10149,26 @@ "name": "createSecondaryStagingStore", "params": [ { - "description": "the scope of the staging store: zone only for now", + "description": "the Zone ID for the staging store", "length": 255, - "name": "scope", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "type": "uuid" + }, + { + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the Zone ID for the staging store", + "description": "the scope of the staging store: zone only for now", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "scope", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the staging store provider name", @@ -9978,41 +10183,24 @@ "name": "details", "required": false, "type": "map" - }, - { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", @@ -10020,23 +10208,18 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -10044,23 +10227,38 @@ "name": "scope", "type": "scopetype" }, - {}, { "description": "the total disk size of the host", "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {} + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + } ] }, { @@ -10078,27 +10276,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -10108,12 +10306,12 @@ "name": "updateLBHealthCheckPolicy", "params": [ { - "description": "ID of load balancer health check policy", + "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": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", - "required": true, - "type": "uuid" + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" }, { "description": "an optional field, whether to the display the policy to the end user or not", @@ -10124,55 +10322,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": "ID of load balancer health check policy", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", + "required": true, + "type": "uuid" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ + {}, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the state of the policy", - "name": "state", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { @@ -10185,24 +10368,19 @@ "name": "responsetime", "type": "int" }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "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 pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { @@ -10211,16 +10389,36 @@ "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" } ], @@ -10231,13 +10429,6 @@ "isasync": true, "name": "removeTungstenFabricPolicyRule", "params": [ - { - "description": "the Uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -10252,48 +10443,55 @@ "name": "ruleuuid", "required": true, "type": "string" + }, + { + "description": "the Uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, - { - "description": "the 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": "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", + "type": "string" + } ] }, { @@ -10302,55 +10500,41 @@ "name": "createLoadBalancerRule", "params": [ { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "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": "privateport", - "required": true, - "type": "integer" + "name": "cidrlist", + "required": false, + "since": "4.18.0.0", + "type": "list" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "openfirewall", + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" - }, - { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "name of the load balancer rule", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "name", + "name": "publicport", "required": true, - "type": "string" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" + "type": "integer" }, { "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", @@ -10360,26 +10544,27 @@ "type": "string" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "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": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", @@ -10390,63 +10575,56 @@ "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": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", "length": 255, - "name": "cidrlist", + "name": "openfirewall", "required": false, - "since": "4.18.0.0", - "type": "list" - } - ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", - "response": [ - { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "type": "boolean" }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" }, { - "description": "the name of the load balancer", + "description": "name of the load balancer rule", + "length": 255, "name": "name", + "required": true, "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "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 load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "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": "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 state of the rule", + "name": "state", "type": "string" }, { @@ -10455,24 +10633,13 @@ "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "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 state of the rule", - "name": "state", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -10485,23 +10652,18 @@ "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" }, { - "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -10510,13 +10672,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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -10525,8 +10687,13 @@ "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", "type": "string" }, { @@ -10538,8 +10705,28 @@ "type": "list" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -10548,13 +10735,18 @@ "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -10563,8 +10755,8 @@ "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -10572,20 +10764,26 @@ "name": "networkid", "type": "string" }, + {}, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "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" } ] }, @@ -10611,31 +10809,31 @@ "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "The configured account's id.", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "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" @@ -10657,8 +10855,8 @@ "related": "listVsphereStoragePolicies", "response": [ { - "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" }, { @@ -10666,34 +10864,74 @@ "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 ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the Storage Policy", + "name": "name", + "type": "string" + }, { "description": "the ID of the Storage Policy", "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "delete a backup repository", + "isasync": false, + "name": "deleteBackupRepository", + "params": [ { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" + "description": "ID of the backup repository to be deleted", + "length": 255, + "name": "id", + "related": "addBackupRepository,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 identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "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 name of the Storage Policy", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Disables out-of-band management for a zone", @@ -10712,18 +10950,13 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host", - "name": "hostid", + "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 password", + "name": "password", "type": "string" }, { @@ -10732,18 +10965,18 @@ "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -10751,307 +10984,86 @@ "name": "status", "type": "boolean" }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "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 interface username", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, {} ], "since": "4.9.0" }, { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", + "description": "Create VM backup", + "isasync": true, + "name": "createBackup", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" - }, - { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "Lists ipv6 firewall rule with the specified ID", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" - }, - { - "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", - "length": 255, - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list ipv6 firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "ID of the VM", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" - }, - { - "description": "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": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "response": [ { - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - {}, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "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": "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 ip address for the port forwarding rule", - "name": "vmguestip", - "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 starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the 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 VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" } - ] + ], + "since": "4.14.0" }, { "description": "Stops a system VM.", "isasync": true, "name": "stopSystemVm", "params": [ - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "The ID of the system virtual machine", "length": 255, @@ -11059,28 +11071,30 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" + }, + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Pod ID for the system VM", - "name": "podid", - "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 link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -11089,64 +11103,60 @@ "type": "date" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "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 control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, + {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { "description": "the Pod name for the system VM", @@ -11154,33 +11164,33 @@ "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { @@ -11189,33 +11199,33 @@ "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -11223,57 +11233,71 @@ "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, {}, { - "description": "the system VM type", - "name": "systemvmtype", + "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 template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" } ] }, @@ -11286,33 +11310,33 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "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", "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" } ] }, @@ -11321,13 +11345,6 @@ "isasync": true, "name": "updateVPC", "params": [ - { - "description": "the display text of the VPC", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, { "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, @@ -11337,13 +11354,20 @@ "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 display text of the VPC", "length": 255, - "name": "customid", + "name": "displaytext", "required": false, - "since": "4.4", "type": "string" }, + { + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" + }, { "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", "length": 255, @@ -11353,96 +11377,39 @@ "type": "string" }, { - "description": "the id of the VPC", + "description": "the name of the VPC", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "publicmtu", + "name": "customid", "required": false, - "since": "4.18.0", - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "the name of the VPC", + "description": "the id of the VPC", "length": 255, - "name": "name", - "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": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - {}, - {}, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, { "description": "an alternate display text of the VPC.", "name": "displaytext", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { @@ -11456,49 +11423,39 @@ "type": "long" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", - "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": "the cidr the VPC", - "name": "cidr", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "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 name of the VPC", - "name": "name", - "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 first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", @@ -11509,35 +11466,25 @@ "type": "boolean" }, { - "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" } ], "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": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -11545,24 +11492,29 @@ "name": "name", "type": "string" }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], @@ -11571,58 +11523,109 @@ ], "type": "list" }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + {}, { "description": "the id of the VPC", "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "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 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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -11631,36 +11634,26 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "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" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { @@ -11668,53 +11661,121 @@ "name": "ip4routing", "type": "string" }, + {}, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "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": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" } ] }, { - "description": "List VM Schedules.", + "description": "Lists all IPv6 firewall rules", "isasync": false, - "name": "listVMSchedule", + "name": "listIpv6FirewallRules", "params": [ + { + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "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": "", "length": 255, @@ -11723,26 +11784,40 @@ "type": "integer" }, { - "description": "ID of VM schedule", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "enabled", + "name": "fordisplay", "required": false, "type": "boolean" }, { - "description": "ID of VM schedule", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", - "required": true, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { @@ -11753,9 +11828,188 @@ "type": "string" }, { - "description": "Action taken by schedule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "action", + "name": "tags", + "required": false, + "type": "map" + } + ], + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "response": [ + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "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 port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "list" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + } + ] + }, + { + "description": "List VM Schedules.", + "isasync": false, + "name": "listVMSchedule", + "params": [ + { + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -11765,10 +12019,44 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Action taken by schedule", + "length": 255, + "name": "action", + "required": false, + "type": "string" + }, + { + "description": "ID of the VM for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], "related": "createVMSchedule,updateVMSchedule", "response": [ + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, { "description": "Timezone of the schedule", "name": "timezone", @@ -11780,9 +12068,14 @@ "type": "date" }, { - "description": "Description of VM schedule", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { "description": "Action", @@ -11790,18 +12083,14 @@ "type": "action" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, + {}, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -11810,26 +12099,20 @@ "type": "boolean" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, - {}, {} ], "since": "4.19.0" @@ -11856,18 +12139,17 @@ } ], "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", @@ -11877,7 +12159,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.17.0" }, @@ -11887,104 +12170,104 @@ "name": "listVolumesMetrics", "params": [ { - "description": "the type of disk volume", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "type", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "tags", + "name": "retrieveonlyresourcecount", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "ids", - "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "displayvolume", "required": false, - "since": "4.9", - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "list volumes on specified host", + "description": "the type of disk volume", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "ids", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "since": "4.3", - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "the ID of the disk volume", + "description": "the ID of the availability zone", "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", + "name": "zoneid", + "related": "createZone,updateZone,listZones,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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "isrecursive", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.19.1", + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the availability zone", + "description": "the name of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the pod id the disk volume belongs to", + "description": "list volumes by disk offering", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { @@ -11995,13 +12278,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -12010,34 +12286,37 @@ "type": "integer" }, { - "description": "", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "4.3", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the disk volume", "length": 255, - "name": "displayvolume", + "name": "id", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "listsystemvms", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list only volumes that are encrypted", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "isencrypted", "required": false, - "type": "uuid" + "since": "4.19.1", + "type": "boolean" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -12047,267 +12326,213 @@ "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "list volumes on specified host", "length": 255, - "name": "listsystemvms", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "isencrypted", + "name": "isrecursive", "required": false, - "since": "4.19.1", "type": "boolean" }, { - "description": "list volumes by disk offering", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "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, - "since": "4.19.1", "type": "uuid" } ], "related": "", "response": [ + {}, { - "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": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + {}, { - "description": "the path of the volume", - "name": "path", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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 display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "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", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "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": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the account associated with the disk volume", - "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": "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": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -12316,29 +12541,33 @@ "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -12346,8 +12575,8 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -12356,38 +12585,38 @@ "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -12396,123 +12625,122 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "the status of the volume", - "name": "status", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the path of the volume", + "name": "path", "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 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": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "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": "name of the disk volume", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, { "description": "the total disk iops", "name": "diskiopstotal", "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 service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "disk size in GiB", + "name": "sizegb", + "type": "string" }, { "description": "cluster id of the volume", @@ -12520,9 +12748,64 @@ "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" } ], "since": "4.9.3" @@ -12533,29 +12816,29 @@ "name": "listDetailOptions", "params": [ { - "description": "the resource type such as UserVm, Template etc.", + "description": "the UUID of the resource (optional)", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "the UUID of the resource (optional)", + "description": "the resource type such as UserVm, Template etc.", "length": 255, - "name": "resourceid", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" } ], "related": "", "response": [ - {}, - {}, { "description": "Map of all possible details and their possible list of values", "name": "details", "type": "map" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -12575,10 +12858,10 @@ "name": "listSslCerts", "params": [ { - "description": "Account ID", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -12591,10 +12874,10 @@ "type": "uuid" }, { - "description": "Project that owns the SSL certificate", + "description": "Account ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -12602,42 +12885,34 @@ "description": "Load balancer rule ID", "length": 255, "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, "type": "uuid" } ], "related": "uploadSslCert", "response": [ - { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" - }, - { - "description": "SSL certificate ID", - "name": "id", - "type": "string" - }, { "description": "certificate", "name": "certificate", "type": "string" }, + {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "account for the certificate", + "name": "account", "type": "string" }, + {}, { - "description": "certificate chain", - "name": "certchain", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project name of the certificate", @@ -12645,24 +12920,23 @@ "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "certificate chain", + "name": "certchain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { @@ -12670,11 +12944,20 @@ "name": "loadbalancerrulelist", "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the certificate", + "name": "projectid", + "type": "string" } ] }, @@ -12683,13 +12966,6 @@ "isasync": false, "name": "listPrivateGateways", "params": [ - { - "description": "list gateways by vlan", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -12699,60 +12975,68 @@ "type": "uuid" }, { - "description": "list private gateway by id", + "description": "list gateways by vpc", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list 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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list gateways by ip address", + "description": "list private gateway by id", "length": 255, - "name": "ipaddress", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", "required": false, - "type": "string" + "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": "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", + "name": "page", "required": false, "type": "integer" }, { - "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": "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" }, @@ -12764,17 +13048,16 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list gateways by state", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list gateways by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" } @@ -12782,13 +13065,8 @@ "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the project name of the private gateway", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the gateway", + "name": "gateway", "type": "string" }, { @@ -12797,45 +13075,45 @@ "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", + "type": "string" }, - {}, - {}, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, + {}, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "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": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { @@ -12844,48 +13122,43 @@ "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" - }, { "description": "the id of the private gateway", "name": "id", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { @@ -12899,14 +13172,24 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { "description": "State of the gateway, can be Creating, Ready, Deleting", "name": "state", "type": "string" + }, + { + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" } ] }, @@ -12934,68 +13217,60 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the project name of the vm", - "name": "project", + "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": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the 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 ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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" }, { @@ -13003,155 +13278,45 @@ "name": "networkkbsread", "type": "long" }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, { "description": "ID of AutoScale VM group", "name": "autoscalevmgroupid", "type": "string" }, - {}, - { - "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": "an optional field whether to the display the vm to the end user or not.", "name": "displayvm", "type": "boolean" }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, { "description": "the password (if exists) of the virtual machine", "name": "password", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { "description": "NICs of the VNF appliance", @@ -13159,153 +13324,148 @@ "type": "list" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "the 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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Guest vm Boot Type", + "name": "boottype", "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": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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": "the group ID of the virtual machine", "name": "groupid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "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": "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 vm", + "name": "ostypeid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "the vGPU type used by the virtual machine", - "name": "vgpu", - "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 date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -13314,416 +13474,135 @@ "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "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 project ID of the affinity group", - "name": "projectid", - "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 account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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": "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "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 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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - } - ], - "type": "set" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "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": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain ID of the security group", + "name": "domainid", + "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 resource tags associated with the rule", - "name": "tags", + "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": "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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 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" - }, - { - "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" - }, - { - "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 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 key name", + "name": "key", "type": "string" }, { @@ -13732,13 +13611,8 @@ "type": "string" }, { - "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" }, { @@ -13747,8 +13621,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -13757,13 +13631,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -13772,29 +13646,106 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the 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 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": "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -13802,23 +13753,23 @@ "name": "ingressrule", "response": [ { - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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" }, { @@ -13826,28 +13777,28 @@ "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 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": "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -13856,18 +13807,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": "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": "tag key name", + "name": "key", "type": "string" }, { @@ -13876,59 +13827,54 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" } ], "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -13937,446 +13883,319 @@ "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "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 id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "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 template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "path of the Domain the router belongs to", + "description": "path of the domain in which the virtual machine exists", "name": "domainpath", "type": "string" }, - {}, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "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": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "list" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", - "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 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": "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the domain associated with the router", - "name": "domain", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the list of nics associated with the router", + "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "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": "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -14385,68 +14204,68 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the 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", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -14454,162 +14273,564 @@ "name": "macaddress", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" } ] }, { - "description": "Updates a disk offering.", - "isasync": false, - "name": "updateDiskOffering", + "description": "Starts an existing internal lb vm.", + "isasync": true, + "name": "startInternalLoadBalancerVM", "params": [ { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "io requests write rate of the disk offering", + "description": "the ID of the internal lb vm", "length": 255, - "name": "iopswriterate", - "required": false, - "since": "4.15", - "type": "long" - }, + "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": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", - "length": 255, - "name": "tags", - "required": false, - "since": "4.15", + "description": "the first DNS for the router", + "name": "dns1", "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 first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "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", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "state of the disk offering", - "length": 255, - "name": "state", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "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 template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", - "type": "long" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "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": "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the 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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "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" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the public IP address for the router", + "name": "publicip", + "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" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + } + ] + }, + { + "description": "Updates a disk offering.", + "isasync": false, + "name": "updateDiskOffering", + "params": [ + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, "since": "4.15", "type": "long" }, + { + "description": "state of the disk offering", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "length (in seconds) of the burst", "length": 255, @@ -14618,6 +14839,14 @@ "since": "4.15", "type": "long" }, + { + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "since": "4.15", + "type": "long" + }, { "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, @@ -14626,119 +14855,152 @@ "type": "boolean" }, { - "description": "updates name of the disk offering with this value", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "name", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "iopsreadratemaxlength", + "name": "sortkey", "required": false, - "since": "4.15", - "type": "long" + "type": "integer" }, { - "description": "sort key of the disk offering, integer", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "ID of the disk offering", "length": 255, - "name": "sortkey", + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemaxlength", + "name": "iopsreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "updates name of the disk offering with this value", "length": 255, - "name": "bytesreadrate", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "iopswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "updates alternate display text of the disk offering with this value", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 4096, - "name": "displaytext", + "name": "domainid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "cachemode", "required": false, "since": "4.15", - "type": "long" - } - ], - "related": "createDiskOffering,listDiskOfferings", - "response": [ + "type": "string" + }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "since": "4.15", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "length": 255, + "name": "tags", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, - {}, { - "description": "state of the disk offering", - "name": "state", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "since": "4.15", "type": "long" - }, + } + ], + "related": "createDiskOffering,listDiskOfferings", + "response": [ { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "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 date this disk offering was created", - "name": "created", - "type": "date" + "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", @@ -14746,23 +15008,33 @@ "type": "long" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "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": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { @@ -14771,70 +15043,80 @@ "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the date this disk offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, + {}, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { "description": "the min iops of the disk offering", "name": "miniops", "type": "long" }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, { "description": "additional key/value details tied with this disk offering", "name": "details", "type": "map" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "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", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { "description": "burst io requests read rate of the disk offering", @@ -14842,53 +15124,64 @@ "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, + {}, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "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": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -14898,14 +15191,6 @@ "isasync": false, "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -14913,13 +15198,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -14927,6 +15205,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" + }, { "description": "the IDs of the VMs to remove from the cluster", "length": 255, @@ -14934,37 +15220,44 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "list" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "the id of the Kubernetes cluster", - "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": "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 id of the Kubernetes cluster", + "name": "id", + "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.19.0" }, @@ -14973,13 +15266,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, @@ -14987,30 +15273,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 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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -15020,12 +15313,11 @@ "name": "resetVpnConnection", "params": [ { - "description": "id of vpn connection", + "description": "an optional account for connection. Must be used with domainId.", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", @@ -15036,19 +15328,20 @@ "type": "uuid" }, { - "description": "an optional account for connection. Must be used with domainId.", + "description": "id of vpn connection", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "required": true, + "type": "uuid" } ], "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "IKE policy of the customer gateway", @@ -15056,38 +15349,38 @@ "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "is connection 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 domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "State of vpn connection", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -15096,96 +15389,96 @@ "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, - {}, { - "description": "the project name", - "name": "project", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { "description": "the connection ID", "name": "id", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "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": "the public IP address", "name": "publicip", "type": "string" }, { - "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": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "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": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "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": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -15195,160 +15488,145 @@ "name": "listKubernetesClusters", "params": [ { - "description": "", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "pagesize", + "name": "clustertype", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "state of the Kubernetes cluster", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "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 the Kubernetes cluster", + "description": "", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "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" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the 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": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, { "description": "Minimum size of the cluster", "name": "minsize", "type": "long" }, - {}, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + {}, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { @@ -15357,9 +15635,9 @@ "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { "description": "the project id of the Kubernetes cluster", @@ -15367,14 +15645,14 @@ "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the name of the zone of the Kubernetes cluster", @@ -15382,44 +15660,48 @@ "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { @@ -15428,53 +15710,64 @@ "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "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": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, + {}, { - "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 Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "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 ID of the cluster", - "name": "ipaddressid", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" } ] @@ -15492,20 +15785,11 @@ "type": "integer" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, - { - "description": "list of scaleup 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": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "minmembers", "required": true, - "type": "list" + "type": "integer" }, { "description": "the name of the autoscale vmgroup", @@ -15523,13 +15807,6 @@ "required": true, "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.", - "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" - }, { "description": "an optional field, whether to the display the group to the end user or not", "length": 255, @@ -15538,6 +15815,21 @@ "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.", + "length": 255, + "name": "maxmembers", + "required": true, + "type": "integer" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + }, { "description": "the autoscale profile that contains information about the vms in the vm group.", "length": 255, @@ -15547,78 +15839,45 @@ "type": "uuid" }, { - "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 scaleup autoscale policies", "length": 255, - "name": "maxmembers", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "integer" + "type": "list" } ], "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "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 public port", + "name": "publicport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the 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": "the id of the guest network the lb rule belongs to", "name": "associatednetworkid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" - }, - { - "description": "the account owning the vm group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "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", + "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 current state of the AutoScale Vm Group", - "name": "state", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { @@ -15627,34 +15886,38 @@ "type": "int" }, { - "description": "the public port", - "name": "publicport", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the name of the autoscale vm group ", + "name": "name", + "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", + "name": "lbprovider", + "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "description": "the domain name of the vm group", + "name": "domain", + "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" }, { @@ -15662,157 +15925,117 @@ "name": "project", "type": "string" }, - { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" - }, { "description": "the project id of the vm group", "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, - {}, { "description": "the public ip address id", "name": "publicipid", "type": "string" }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the public ip address", "name": "publicip", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" - } - ] - }, - { - "description": "Change the BGP peers for a VPC.", - "isasync": true, - "name": "changeBgpPeersForVpc", - "params": [ + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { - "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", - "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "required": false, + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", "type": "list" }, { - "description": "UUID of the VPC which the Bgp Peers are associated to.", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - } - ], - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "response": [ - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the account of the bgp peer", + "description": "the account owning the vm group", "name": "account", "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 bgp peer", - "name": "domain", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "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": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, + } + ] + }, + { + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", + "params": [ { - "description": "id of the bgp peer", + "description": "the ID of the load balancer rule", + "length": 255, "name": "id", - "type": "string" - }, + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "password of bgp peer", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} - ], - "since": "4.20.0" + ] }, { "description": "add a baremetal ping pxe server", @@ -15820,27 +16043,12 @@ "name": "addBaremetalPxePingServer", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Tftp root directory of PXE server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "tftpdir", + "name": "password", "required": true, "type": "string" }, - { - "description": "Username of PING storage server", - "length": 255, - "name": "pingcifsusername", - "required": false, - "type": "string" - }, { "description": "PING storage server ip", "length": 255, @@ -15849,11 +16057,12 @@ "type": "string" }, { - "description": "type of pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "pxeservertype", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Pod Id", @@ -15863,13 +16072,6 @@ "required": false, "type": "uuid" }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "URL of the external pxe device", "length": 255, @@ -15891,6 +16093,27 @@ "required": true, "type": "string" }, + { + "description": "type of pxe device", + "length": 255, + "name": "pxeservertype", + "required": true, + "type": "string" + }, + { + "description": "Username of PING storage server", + "length": 255, + "name": "pingcifsusername", + "required": false, + "type": "string" + }, + { + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, + "type": "string" + }, { "description": "Password of PING storage server", "length": 255, @@ -15901,31 +16124,34 @@ ], "related": "", "response": [ + { + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" + }, { "description": "Root directory on PING storage server", "name": "pingdir", "type": "string" }, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "device id of ", + "name": "id", "type": "string" }, - {}, { "description": "url", "name": "url", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -15934,15 +16160,12 @@ "type": "integer" }, { - "description": "name of the provider", - "name": "provider", - "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": "PING storage server ip", "name": "pingstorageserverip", @@ -15951,29 +16174,103 @@ ] }, { - "description": "Deletes a load balancer rule.", + "description": "Change the BGP peers for a VPC.", "isasync": true, - "name": "deleteLoadBalancerRule", + "name": "changeBgpPeersForVpc", "params": [ { - "description": "the ID of the load balancer rule", + "description": "UUID of the VPC which the Bgp Peers are associated to.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" + }, + { + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "required": false, + "type": "list" } ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "response": [ {}, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, {}, @@ -15981,13 +16278,9 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } - ] + ], + "since": "4.20.0" }, { "description": "list portable IP ranges", @@ -15995,18 +16288,18 @@ "name": "listPortableIpRanges", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Id of the portable ip range", @@ -16034,8 +16327,8 @@ "related": "createPortableIpRange", "response": [ { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { @@ -16043,34 +16336,25 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "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 start ip of the portable IP range", - "name": "startip", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { @@ -16078,18 +16362,8 @@ "name": "portableipaddress", "response": [ { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { @@ -16103,40 +16377,59 @@ "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": "VPC the ip belongs to", - "name": "vpcid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", "name": "state", "type": "string" + }, + { + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" } ], "type": "list" }, - {}, - {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" - } + }, + {} ] }, { @@ -16160,22 +16453,22 @@ "name": "virtualmachineid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Base64 encoded VM user data", "name": "userdata", "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.4" @@ -16194,10 +16487,10 @@ "type": "uuid" }, { - "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" }, @@ -16209,31 +16502,31 @@ "type": "list" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of 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" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -16258,27 +16551,27 @@ } ], "response": [ - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -16287,13 +16580,6 @@ "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, @@ -16301,39 +16587,40 @@ "related": "listNics", "required": true, "type": "uuid" - } - ], - "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", - "type": "string" }, { - "description": "Secondary IP address", + "description": "Secondary IP Address", + "length": 255, "name": "ipaddress", + "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 vm", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the ID of the nic", "name": "nicid", "type": "string" }, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the network", + "name": "networkid", "type": "string" }, { @@ -16343,10 +16630,16 @@ }, {}, { - "description": "the ID of the network", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + { + "description": "Secondary IP address", + "name": "ipaddress", + "type": "string" + }, + {} ] }, { @@ -16354,13 +16647,6 @@ "isasync": false, "name": "quotaTariffUpdate", "params": [ - { - "description": "DEPRECATED. Integer value for the usage type of the resource", - "length": 255, - "name": "usagetype", - "required": false, - "type": "integer" - }, { "description": "Quota tariff's name", "length": 65535, @@ -16369,6 +16655,14 @@ "since": "4.18.0.0", "type": "string" }, + { + "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": "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, @@ -16378,12 +16672,11 @@ "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. 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" }, { "description": "The quota tariff value of the resource as per the default unit.", @@ -16393,55 +16686,50 @@ "type": "double" }, { - "description": "Quota tariff's description. Inform empty to remove the description.", - "length": 65535, - "name": "description", + "description": "Position in the execution sequence for tariffs of the same type", + "length": 255, + "name": "position", "required": false, - "since": "4.18.0.0", - "type": "string" + "since": "4.20.0.0", + "type": "integer" }, { - "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "startdate", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "length": 65535, + "name": "activationrule", "required": false, - "type": "date" + "since": "4.18.0.0", + "type": "string" }, { - "description": "Position in the execution sequence for tariffs of the same type", + "description": "DEPRECATED. Integer value for the usage type of the resource", "length": 255, - "name": "position", + "name": "usagetype", "required": false, - "since": "4.20.0.0", "type": "integer" } ], "related": "quotaTariffList,quotaTariffCreate", "response": [ - {}, - { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" - }, { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" + "description": "usageName", + "name": "usageName", + "type": "string" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, + {}, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { @@ -16450,34 +16738,30 @@ "type": "bigdecimal" }, { - "description": "currency", - "name": "currency", - "type": "string" + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" }, + {}, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "usageName", - "name": "usageName", + "description": "name", + "name": "name", "type": "string" }, { - "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": "description", + "name": "description", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" }, { "description": "the ID of the tariff", @@ -16490,21 +16774,30 @@ "type": "string" }, { - "description": "description", - "name": "description", + "description": "currency", + "name": "currency", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "name", - "name": "name", - "type": "string" - }, - {} + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, + { + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "usage type description", + "name": "usageTypeDescription", + "type": "string" + } ], "since": "4.7.0" }, @@ -16523,28 +16816,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -16552,21 +16845,21 @@ "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" }, + { + "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, @@ -16576,6 +16869,12 @@ } ], "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", @@ -16591,12 +16890,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -16606,30 +16899,32 @@ "name": "deleteResourceIcon", "params": [ { - "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" }, { - "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" } ], "response": [ + {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -16637,12 +16932,10 @@ "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.16.0.0" }, @@ -16653,20 +16946,25 @@ "params": [], "related": "", "response": [ + { + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" + }, { "description": "the retention time for Instances disks stats", "name": "instancesdisksstatsretentiontime", "type": "integer" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { "description": "the min CPU count for the service offering used by the shared filesystem instance", @@ -16674,8 +16972,18 @@ "type": "integer" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" + }, + { + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", + "type": "string" + }, + { + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, { @@ -16684,18 +16992,19 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" }, { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", - "type": "boolean" + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, + {}, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, { @@ -16704,23 +17013,28 @@ "type": "integer" }, { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", "type": "long" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" + }, + { + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", "type": "boolean" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", "type": "boolean" }, { @@ -16729,34 +17043,28 @@ "type": "integer" }, { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", + "type": "long" }, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", - "type": "string" + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", + "type": "integer" }, { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" - }, - {}, - { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { @@ -16770,13 +17078,8 @@ "type": "boolean" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" - }, - { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, { @@ -16784,27 +17087,17 @@ "name": "allowuserviewalldomainaccounts", "type": "boolean" }, + {}, { - "description": "the min Ram size for the service offering used by the shared filesystem instance", - "name": "sharedfsvmminramsize", - "type": "integer" - }, - { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" - }, - { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" + "description": "version of the cloud stack", + "name": "cloudstackversion", + "type": "string" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", "type": "boolean" - }, - {} + } ] }, { @@ -16823,27 +17116,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "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" - } + {} ] }, { @@ -16877,13 +17170,13 @@ "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ { - "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -16891,31 +17184,31 @@ "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "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": "state of the network provider", "name": "state", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -16942,31 +17235,22 @@ "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", + "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" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "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": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -16974,61 +17258,25 @@ "name": "diskIopsReadRate", "type": "long" }, - {}, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "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": "the bytes allocated", "name": "virtualsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "name of the availability zone", @@ -17041,38 +17289,38 @@ "type": "date" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "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": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -17080,35 +17328,24 @@ "name": "isextractable", "type": "boolean" }, - {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "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 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", + "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" }, { @@ -17117,33 +17354,38 @@ "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { @@ -17152,211 +17394,246 @@ "type": "map" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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", - "name": "destroyed", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "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": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the path of the volume", - "name": "path", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "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": "the disk utilization", - "name": "utilization", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { "description": "ID of the service offering for root disk", @@ -17364,15 +17641,31 @@ "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": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - } + "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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + {} ], "since": "4.19.1" }, @@ -17381,6 +17674,14 @@ "isasync": false, "name": "listManagementServersMetrics", "params": [ + { + "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", + "length": 255, + "name": "peers", + "required": false, + "since": "4.20.1.0", + "type": "boolean" + }, { "description": "include system level stats", "length": 255, @@ -17390,11 +17691,11 @@ "type": "boolean" }, { - "description": "the name of the management server", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the id of the management server", @@ -17404,13 +17705,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -17424,18 +17718,35 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", + "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": "the number of client sessions active on this Management Server", + "name": "sessions", "type": "long" }, { @@ -17444,43 +17755,54 @@ "type": "double[]" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "the current cpu load", + "name": "cpuload", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + }, + { + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" + }, + { + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "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 blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "the system is running against a local database", - "name": "dbislocal", + "description": "the system has a usage server running locally", + "name": "usageislocal", "type": "boolean" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", - "type": "string" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "The number of threads", - "name": "threadstotalcount", - "type": "integer" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "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" }, { @@ -17489,45 +17811,43 @@ "type": "string" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "Total system memory", - "name": "systemmemorytotal", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, - {}, { - "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 number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, - {}, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" }, { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", "type": "string" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", + "description": "The number of threads", + "name": "threadstotalcount", "type": "integer" }, { @@ -17536,13 +17856,18 @@ "type": "string" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", + "description": "the log files and their usage on disk", + "name": "loginfo", + "type": "string" + }, + { + "description": "The number of daemon threads", + "name": "threadsdaemoncount", "type": "integer" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", + "description": "The number of runnable threads", + "name": "threadsrunnablecount", "type": "integer" }, { @@ -17550,70 +17875,56 @@ "name": "availableprocessors", "type": "integer" }, - { - "description": "the current cpu load", - "name": "cpuload", - "type": "string" - }, { "description": "Amount of memory used", "name": "systemmemoryused", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" - }, - { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 name of the management server", + "name": "name", + "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", "type": "integer" }, + { + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" + }, { "description": "the version of the java distribution running the management server process", "name": "javaversion", "type": "string" - }, - { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" } ], "since": "4.17.0" @@ -17623,19 +17934,11 @@ "isasync": true, "name": "removeFromLoadBalancerRule", "params": [ - { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" - }, { "description": "The ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": true, "type": "uuid" }, @@ -17646,6 +17949,14 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "list" + }, + { + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "length": 255, + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" } ], "response": [ @@ -17654,16 +17965,16 @@ "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {}, { @@ -17678,6 +17989,21 @@ "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", + "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, @@ -17686,41 +18012,40 @@ "type": "boolean" }, { - "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": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "list instance groups by ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list instance groups by ID", + "description": "list instance groups by name", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -17736,37 +18061,23 @@ "name": "isrecursive", "required": false, "type": "boolean" - }, - { - "description": "list instance groups by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -17775,19 +18086,18 @@ "type": "boolean" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, - {}, { - "description": "the project name of the instance group", - "name": "project", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { @@ -17796,26 +18106,27 @@ "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 domain ID of the instance group", - "name": "domainid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "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" - }, - {} + } ] }, { @@ -17841,74 +18152,28 @@ ], "related": "listStaticRoutes", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the project name of the static route", - "name": "project", - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -17917,8 +18182,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -17927,26 +18192,52 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, { "description": "the domain path associated with the static route", "name": "domainpath", "type": "string" }, + {}, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { @@ -17955,19 +18246,39 @@ "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, {}, { - "description": "the state of the static route", - "name": "state", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the project name of the static route", + "name": "project", "type": "string" } ] @@ -17987,6 +18298,11 @@ } ], "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", @@ -17997,18 +18313,13 @@ "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" - }, - {} + } ] }, { @@ -18016,13 +18327,6 @@ "isasync": false, "name": "updateDomain", "params": [ - { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, { "description": "updates domain with this name", "length": 255, @@ -18037,119 +18341,142 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": true, "type": "uuid" + }, + { + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" } ], "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, {}, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, { "description": "details for the domain", "name": "domaindetails", "type": "map" }, + {}, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "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 domain", + "name": "vpcavailable", + "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "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 number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { @@ -18158,8 +18485,8 @@ "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" }, { @@ -18168,14 +18495,9 @@ "type": "date" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { "description": "the total number of cpu cores owned by domain", @@ -18183,8 +18505,8 @@ "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { @@ -18193,75 +18515,79 @@ "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "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 snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, - {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "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 vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "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) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { "description": "the name of the domain", @@ -18269,39 +18595,24 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the path of the domain", - "name": "path", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { "description": "the total number of public ip addresses this domain can acquire", "name": "iplimit", "type": "string" - }, - { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -18322,14 +18633,20 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "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 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": "list of scaleup autoscale policies", @@ -18337,18 +18654,38 @@ "type": "list" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, { "description": "the project id of the vm group", "name": "projectid", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { @@ -18357,18 +18694,18 @@ "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -18377,96 +18714,70 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private port", + "name": "privateport", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, + {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "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 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 vm group ID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" - }, { "description": "the name of the guest network the lb rule belongs to", "name": "associatednetworkname", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { "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", - "type": "string" - }, - { - "description": "the account owning the vm group", - "name": "account", - "type": "string" } ] }, @@ -18476,12 +18787,28 @@ "name": "createSnapshotPolicy", "params": [ { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, - "name": "intervaltype", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "length": 255, + "name": "schedule", "required": true, "type": "string" }, + { + "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": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", "length": 255, @@ -18490,21 +18817,6 @@ "required": false, "type": "list" }, - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "maximum number of snapshots to retain", - "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" - }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, @@ -18520,41 +18832,26 @@ "type": "map" }, { - "description": "the ID of the disk volume", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "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", + "name": "intervaltype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "description": "maximum number of snapshots to retain", "length": 255, - "name": "schedule", + "name": "maxsnaps", "required": true, - "type": "string" + "type": "integer" } ], "related": "updateSnapshotPolicy,listSnapshotPolicies", "response": [ + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { @@ -18567,28 +18864,28 @@ "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 account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -18597,43 +18894,42 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, { "description": "is this policy for display to the regular user", @@ -18641,9 +18937,15 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + {}, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { "description": "the UUID of the latest async job acting on this object", @@ -18651,11 +18953,20 @@ "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" }, - {} + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -18673,21 +18984,21 @@ } ], "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": "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" }, {}, { @@ -18707,118 +19018,36 @@ "description": "The ID of the volume to unmanage", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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" } ], "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.19.1" - }, - { - "description": "Adds an API permission to a role", - "isasync": false, - "name": "createRolePermission", - "params": [ - { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - }, - { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, - "type": "string" }, { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" - } - ], - "related": "listRolePermissions", - "response": [ - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "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 name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the ID of the role permission", - "name": "id", - "type": "string" - }, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" } ], - "since": "4.9.0" + "since": "4.19.1" }, { "description": "List system virtual machines.", @@ -18826,12 +19055,18 @@ "name": "listSystemVms", "params": [ { - "description": "the host ID of the system VM", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "systemvmtype", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "the state of the system VM", @@ -18841,18 +19076,25 @@ "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "CPU arch of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" + }, + { + "description": "the Zone ID of the system VM", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "3.0.1", "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the system VM", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -18871,13 +19113,6 @@ "required": false, "type": "integer" }, - { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - }, { "description": "the Pod ID of the system VM", "length": 255, @@ -18887,24 +19122,26 @@ "type": "uuid" }, { - "description": "the Zone ID of the system VM", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "3.0.1", "type": "uuid" }, { - "description": "", + "description": "the host ID of the system VM", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the system VM", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" } @@ -18912,43 +19149,28 @@ "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { @@ -18957,33 +19179,38 @@ "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "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 name of the system VM", + "name": "name", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -18992,23 +19219,30 @@ "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, + {}, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { @@ -19017,49 +19251,68 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, - {}, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { "description": "the systemvm agent version", "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "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 private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -19068,19 +19321,18 @@ "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -19089,18 +19341,93 @@ "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" + }, + { + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + } + ] + }, + { + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", + "params": [ + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + }, + { + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the name of the role to which the role permission belongs", + "name": "rolename", + "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 api name or wildcard rule", + "name": "rule", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -19109,35 +19436,24 @@ "type": "integer" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the description of the role permission", + "name": "description", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" } - ] + ], + "since": "4.9.0" }, { "description": "Detaches a disk volume from a virtual machine.", "isasync": true, "name": "detachVolume", "params": [ - { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "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" - }, { "description": "the device ID on the virtual machine where volume is detached from", "length": 255, @@ -19152,432 +19468,440 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "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", + "required": false, + "type": "uuid" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "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 virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "pod name of the volume", + "name": "podname", "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 disk offering", - "name": "diskofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "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": "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": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + {}, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "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": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "state of the virtual machine", + "name": "vmstate", "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 format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "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", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the ID of the 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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "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": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "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", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "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": "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": "shared or local storage", + "name": "storagetype", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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 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": "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": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "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" } ], "type": "set" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - {}, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "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": "the project id of the vpn", + "name": "projectid", "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", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" } ] @@ -19596,45 +19920,45 @@ "type": "uuid" }, { - "description": "the ID of the private gateway", + "description": "the ID of the network", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the ID of the network", + "description": "the ID of the private gateway", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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" + } ] }, { @@ -19642,13 +19966,6 @@ "isasync": false, "name": "listTungstenFabricAddressGroup", "params": [ - { - "description": "the uuid of Tungsten-Fabric address group", - "length": 255, - "name": "addressgroupuuid", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -19657,13 +19974,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -19677,28 +19987,38 @@ "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "createTungstenFabricAddressGroup", - "response": [ + }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": false, + "type": "string" + } + ], + "related": "createTungstenFabricAddressGroup", + "response": [ + {}, { "description": "Tungsten-Fabric address group uuid", "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, { @@ -19706,22 +20026,26 @@ "name": "zonename", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, {}, + { + "description": "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 length", - "name": "ipprefixlen", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -19741,21 +20065,30 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ + { + "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 action (if issued)", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the operation result description", + "name": "description", "type": "string" }, - {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -19764,13 +20097,8 @@ "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { @@ -19778,14 +20106,10 @@ "name": "enabled", "type": "boolean" }, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -19794,18 +20118,18 @@ "type": "powerstate" }, { - "description": "the operation result description", - "name": "description", + "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 username", + "name": "username", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" } ], @@ -19816,6 +20140,14 @@ "isasync": false, "name": "listLdapUsers", "params": [ + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", "length": 255, @@ -19824,17 +20156,16 @@ "type": "string" }, { - "description": "linked domain", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -19846,17 +20177,10 @@ "since": "4.13", "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -19868,21 +20192,14 @@ "name": "lastname", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's username", + "name": "username", "type": "string" }, - {}, { - "description": "The user's email", - "name": "email", + "description": "The user's domain", + "name": "domain", "type": "string" }, { @@ -19891,23 +20208,30 @@ "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "The user's email", + "name": "email", + "type": "string" + }, + {}, { "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" } ], @@ -19919,26 +20243,34 @@ "name": "createVMSchedule", "params": [ { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Description of the schedule", + "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": "description", - "required": false, + "name": "schedule", + "required": true, "type": "string" }, { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, + { + "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, @@ -19954,70 +20286,66 @@ "type": "boolean" }, { - "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", + "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": "action", - "required": true, - "type": "string" + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "Description of the schedule", "length": 255, - "name": "schedule", - "required": true, + "name": "description", + "required": false, "type": "string" - }, - { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" } ], "related": "updateVMSchedule", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" + "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", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, {}, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", "type": "date" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", + "description": "Date from which the schedule is active", + "name": "startdate", "type": "date" }, { @@ -20026,20 +20354,16 @@ "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "the ID of VM schedule", + "name": "id", + "type": "string" }, - { - "description": "Action", - "name": "action", - "type": "action" - } + {} ], "since": "4.19.0" }, @@ -20049,31 +20373,33 @@ "name": "listIpForwardingRules", "params": [ { - "description": "", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "page", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -20085,87 +20411,82 @@ "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", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Lists rule with the specified ID.", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list the rule belonging to this public IP address", + "description": "", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "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" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { "description": "the starting port of port forwarding rule's private port range", "name": "privateport", "type": "string" }, + {}, + {}, { "description": "the ending port of port forwarding rule's private port range", "name": "publicendport", "type": "string" }, { - "description": "the 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", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -20174,13 +20495,8 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -20189,19 +20505,28 @@ "type": "boolean" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -20209,13 +20534,8 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -20224,13 +20544,13 @@ "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": "tag key name", + "name": "key", "type": "string" }, { @@ -20239,8 +20559,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -20249,27 +20569,37 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag 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", "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 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", @@ -20277,16 +20607,10 @@ "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", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" - }, - {} + } ] }, { @@ -20295,16 +20619,9 @@ "name": "createSnapshot", "params": [ { - "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" }, @@ -20316,19 +20633,21 @@ "type": "string" }, { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "list" }, { - "description": "Map of tags (key/value pairs)", + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", "length": 255, - "name": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", @@ -20338,21 +20657,11 @@ "type": "string" }, { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "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" - }, - { - "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "description": "the name of the snapshot", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "since": "4.19.0", - "type": "list" + "type": "string" }, { "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", @@ -20363,33 +20672,53 @@ "type": "uuid" }, { - "description": "quiesce vm if true", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "quiescevm", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "asynchronous backup if true", + "length": 255, + "name": "asyncbackup", "required": false, "type": "boolean" + }, + { + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ { - "description": "the account associated with the snapshot", - "name": "account", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -20398,14 +20727,8 @@ "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "the status of the template", - "name": "status", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -20414,33 +20737,60 @@ "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + {}, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { @@ -20448,18 +20798,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -20473,83 +20818,82 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "resource type", "name": "resourcetype", "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, - {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { "description": "the domain ID of the snapshot's account", @@ -20557,48 +20901,28 @@ "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the project id of the snapshot", + "name": "projectid", "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 disk volume", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" } ] @@ -20609,40 +20933,42 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the Pod ID for the storage pool", + "description": "host ID of the storage pools", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "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": "the storage pool path", + "description": "the ID of the storage pool", "length": 255, - "name": "path", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "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": "If true, lists the custom stats of the storage pool", @@ -20653,33 +20979,31 @@ "type": "boolean" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the status of the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "status", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "the storage pool path", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "host ID of the storage pools", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the status of the storage pool", + "description": "the name of the storage pool", "length": 255, - "name": "status", + "name": "name", "required": false, "type": "string" }, @@ -20692,24 +21016,24 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "name", + "name": "ipaddress", "required": false, "type": "string" } @@ -20717,155 +21041,149 @@ "related": "", "response": [ { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the storage pool path", - "name": "path", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { @@ -20874,14 +21192,20 @@ "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + {}, + { + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", + "type": "string" }, { "description": "the host's currently used disk size", @@ -20889,34 +21213,39 @@ "type": "long" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" } ], "since": "4.9.3" @@ -20927,101 +21256,141 @@ "name": "createSSHKeyPair", "params": [ { - "description": "Name of the keypair", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the ssh key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "an optional project for the ssh key", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "Name of the keypair", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" + }, + { + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "Private key", + "name": "privatekey", "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 project id of the keypair owner", + "name": "projectid", + "type": "string" }, + {}, { "description": "the domain id of the keypair owner", "name": "domainid", "type": "string" }, { - "description": "Private key", - "name": "privatekey", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a backup offering", + "isasync": false, + "name": "deleteBackupOffering", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "ID of the backup offering", + "length": 255, + "name": "id", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 name of the keypair owner", - "name": "domain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} - ] + ], + "since": "4.14.0" }, { "description": "list Tungsten-Fabric service group", @@ -21029,9 +21398,17 @@ "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", "required": false, "type": "string" }, @@ -21043,20 +21420,12 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "List by keyword", "length": 255, - "name": "servicegroupuuid", + "name": "keyword", "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, @@ -21068,8 +21437,8 @@ "related": "createTungstenFabricServiceGroup", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { @@ -21078,10 +21447,16 @@ "type": "int" }, { - "description": "Tungsten-Fabric service group 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" + }, { "description": "Tungsten-Fabric service group protocol", "name": "protocol", @@ -21092,12 +21467,6 @@ "name": "zoneid", "type": "long" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric service group end port", "name": "endport", @@ -21105,9 +21474,9 @@ }, {}, { - "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 service group uuid", @@ -21122,40 +21491,47 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "end port for this egress rule", + "description": "start port for this egress rule", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, { - "description": "user to security group mapping", + "description": "TCP is default. UDP is the other supported protocol", "length": 255, - "name": "usersecuritygrouplist", + "name": "protocol", "required": false, - "type": "map" + "type": "string" }, { - "description": "start port for this egress rule", + "description": "type of the icmp message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "end port for this egress rule", "length": 255, - "name": "securitygroupname", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { "description": "an optional project of the security group", @@ -21166,27 +21542,20 @@ "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "account", + "name": "securitygroupname", "required": false, "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, "type": "uuid" }, - { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, { "description": "error code for this icmp message", "length": 255, @@ -21202,34 +21571,19 @@ "type": "list" }, { - "description": "TCP is default. UDP is the other supported protocol", + "description": "user to security group mapping", "length": 255, - "name": "protocol", + "name": "usersecuritygrouplist", "required": false, - "type": "string" + "type": "map" } ], "related": "authorizeSecurityGroupIngress", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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" }, { @@ -21238,15 +21592,9 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -21254,8 +21602,13 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -21263,13 +21616,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" }, { @@ -21278,58 +21631,74 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "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" } ], "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", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", "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" }, @@ -21339,49 +21708,47 @@ "name": "listStoragePools", "params": [ { - "description": "If true, lists the custom stats of the storage pool", + "description": "", "length": 255, - "name": "storagecustomstats", + "name": "page", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "integer" }, { - "description": "the status of the storage pool", + "description": "", "length": 255, - "name": "status", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "page", + "name": "storagecustomstats", "required": false, - "type": "integer" + "since": "4.18.1", + "type": "boolean" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the storage pool path", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the status of the storage pool", "length": 255, - "name": "pagesize", + "name": "status", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of the storage pool", @@ -21392,54 +21759,56 @@ "type": "uuid" }, { - "description": "host ID of the storage pools", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the storage pool", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "name", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the scope of the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the storage pool path", + "description": "host ID of the storage pools", "length": 255, - "name": "path", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "the scope of the storage pool", "length": 255, - "name": "ipaddress", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the storage pool", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" } @@ -21447,38 +21816,23 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "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 overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -21487,8 +21841,8 @@ "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { @@ -21497,25 +21851,29 @@ "type": "storagepoolstatus" }, { - "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 Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "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 Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -21523,91 +21881,107 @@ "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the 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 storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "the ID of the storage pool", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "Storage provider for this pool", + "name": "provider", "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 ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, - {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "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 ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + {}, + {} ] }, { @@ -21624,20 +21998,13 @@ "type": "integer" }, { - "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 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, @@ -21646,6 +22013,14 @@ "since": "4.16.0", "type": "boolean" }, + { + "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "length": 255, + "name": "hypervisor", + "required": false, + "since": "4.19.1", + "type": "string" + }, { "description": "ID of the hypervisor capability", "length": 255, @@ -21654,6 +22029,13 @@ "required": false, "type": "uuid" }, + { + "description": "set true to enable security group for this hypervisor.", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, { "description": "set true to enable storage motion support for this hypervisor", "length": 255, @@ -21663,11 +22045,11 @@ "type": "boolean" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "securitygroupenabled", + "name": "maxguestslimit", "required": false, - "type": "boolean" + "type": "long" }, { "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", @@ -21676,31 +22058,35 @@ "required": false, "since": "4.16.0", "type": "integer" - }, - { - "description": "the hypervisor version for which the hypervisor capabilities are to be updated", - "length": 255, - "name": "hypervisorversion", - "required": false, - "since": "4.19.1", - "type": "string" } ], "related": "listHypervisorCapabilities", "response": [ + {}, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "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": "true if storage motion is supported", "name": "storagemotionenabled", "type": "boolean" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -21713,36 +22099,24 @@ "name": "vmsnapshotenabled", "type": "boolean" }, - {}, - {}, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - }, - { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", "type": "integer" } ], @@ -21767,13 +22141,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", "length": 255, @@ -21781,6 +22148,13 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", @@ -21791,118 +22165,133 @@ "type": "long" }, { - "description": "events available for the host", - "name": "events", - "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", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "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": "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 CPU speed of the host", + "name": "cpuspeed", "type": "long" }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, { "description": "comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone name of the host", + "name": "zonename", "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": "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", + "name": "cpuallocated", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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 CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { @@ -21910,151 +22299,260 @@ "name": "networkkbsread", "type": "long" }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, { "description": "the amount of the host's memory currently allocated", "name": "memoryallocated", - "type": "string" + "type": "long" }, { - "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 host version", - "name": "version", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "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", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, - {}, { "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "averageload", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the host type", - "name": "type", - "type": "type" + "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", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, { "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": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" } ] @@ -22076,23 +22574,8 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, - { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device name", - "name": "vsmdevicename", - "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" }, { @@ -22100,52 +22583,67 @@ "name": "vsmdevicestate", "type": "string" }, + {}, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, - {}, { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "The Config State (Primary/Standby) of the VSM", "name": "vsmconfigstate", "type": "string" }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, { "description": "The mode of the VSM (standalone/HA)", "name": "vsmconfigmode", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "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", + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", "type": "int" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" + }, + { + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" } ] }, @@ -22159,18 +22657,12 @@ "length": 255, "name": "id", "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, + "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", @@ -22181,6 +22673,12 @@ "description": "is domain admin allowed to create offerings with tags", "name": "isallowed", "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -22190,11 +22688,19 @@ "name": "addNicToVirtualMachine", "params": [ { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "Virtual Machine ID", "length": 255, - "name": "dhcpoptions", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "IP Address for the new network", + "length": 255, + "name": "ipaddress", "required": false, - "type": "map" + "type": "string" }, { "description": "Mac Address for the new network", @@ -22204,45 +22710,37 @@ "type": "string" }, { - "description": "Network ID", + "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "dhcpoptions", + "required": false, + "type": "map" }, { - "description": "Virtual Machine ID", + "description": "Network ID", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" - }, - { - "description": "IP Address for the new network", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "the name of the domain in which the virtual machine exists", @@ -22250,210 +22748,155 @@ "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "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 name of the vm", + "name": "osdisplayname", + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the affinity group", + "name": "name", "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 IPv6 address of network", - "name": "ip6address", + "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "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 cidr of IPv6 network", - "name": "ip6cidr", - "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -22461,31 +22904,25 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "the hypervisor on which the template runs", @@ -22493,230 +22930,221 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "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": "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 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 domain name of the affinity group", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "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 ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "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": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -22725,136 +23153,74 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the state of the virtual machine", + "name": "state", "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 group name of the virtual machine", - "name": "group", - "type": "string" + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -22862,140 +23228,40 @@ "name": "receivedbytes", "type": "long" }, - {}, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "User VM type", + "name": "vmtype", "type": "string" }, + {}, { "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { "description": "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -23006,18 +23272,23 @@ "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": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -23031,46 +23302,41 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "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" }, { @@ -23079,60 +23345,55 @@ "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" + }, + { + "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" } ], "type": "set" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "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", + "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": "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" }, { @@ -23141,41 +23402,41 @@ "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 key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -23183,18 +23444,13 @@ "name": "domainpath", "type": "string" }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -23203,32 +23459,47 @@ "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -23237,88 +23508,346 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "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" } ], "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 project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + } + ] + }, + { + "description": "Returns SAML2 CloudStack Service Provider MetaData", + "isasync": false, + "name": "getSPMetadata", + "params": [], + "related": "", + "response": [ + { + "description": "The Metadata XML", + "name": "metadata", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -23328,12 +23857,11 @@ "name": "listStaticRoutes", "params": [ { - "description": "list static route 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": "listStaticRoutes", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list static routes by state", @@ -23343,42 +23871,42 @@ "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list static routes by gateway id", "length": 255, - "name": "tags", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list static route by id", "length": 255, - "name": "page", + "name": "id", + "related": "listStaticRoutes", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list static routes by gateway id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list static routes by vpc id", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -23389,82 +23917,58 @@ "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list static routes by vpc id", "length": 255, - "name": "listall", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "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": "", "response": [ - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the static route", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, { "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 domain associated with the static route", + "name": "domain", + "type": "string" }, + {}, { - "description": "the project name of the static route", - "name": "project", + "description": "the ID of static route", + "name": "id", "type": "string" }, { @@ -23472,72 +23976,92 @@ "name": "account", "type": "string" }, - {}, { "description": "the list of resource tags associated with static route", "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": "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": "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": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the ID of static route", - "name": "id", + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "the project name of the static route", + "name": "project", "type": "string" }, { @@ -23546,13 +24070,18 @@ "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -23563,48 +24092,57 @@ "name": "listPublicIpAddresses", "params": [ { - "description": "list only static NAT IP addresses", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "isstaticnat", + "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": "makes the API's response contains only the resource count", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "forsystemvms", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "lists the specified IP address", + "description": "list only static NAT IP addresses", "length": 255, - "name": "ipaddress", + "name": "isstaticnat", + "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 only IPs used for load balancing", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "forloadbalancing", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "lists all public IP addresses by state", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "lists all public IP addresses by zone ID", @@ -23615,169 +24153,164 @@ "type": "uuid" }, { - "description": "list only source NAT IP addresses", - "length": 255, - "name": "issourcenat", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "pagesize", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "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": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists IP address by ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List IPs belonging to the VPC", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "limits search results to allocated public IP addresses", + "description": "", "length": 255, - "name": "allocatedonly", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "tags", + "name": "retrieveonlyresourcecount", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "", + "description": "list only IPs used for load balancing", "length": 255, - "name": "page", + "name": "forloadbalancing", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "lists all public IP addresses by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "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": "lists all public IP addresses by VLAN ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "keyword", + "name": "allocatedonly", "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 only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the virtual network for the IP address", + "description": "lists all public IP addresses by physical network ID", "length": 255, - "name": "forvirtualnetwork", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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 resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only source NAT IP addresses", "length": 255, - "name": "fordisplay", + "name": "issourcenat", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "lists all public IP addresses by source network ID", + "description": "lists the specified IP address", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ipaddress", "required": false, - "since": "4.13.0", - "type": "uuid" + "type": "string" }, { - "description": "lists IP address by ID", + "description": "the virtual network for the IP address", "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if range is dedicated for system VMs", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "forsystemvms", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "uuid" } ], "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -23785,25 +24318,19 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { @@ -23811,54 +24338,45 @@ "name": "vlanname", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "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 physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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": "virtual machine type the ip address is assigned to", "name": "virtualmachinetype", "type": "string" }, + {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { @@ -23866,8 +24384,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -23876,13 +24394,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -23891,18 +24409,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { @@ -23911,8 +24429,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -23924,18 +24442,13 @@ "type": "list" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "public IP address id", - "name": "id", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { @@ -23944,24 +24457,24 @@ "type": "boolean" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" }, { "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", @@ -23969,48 +24482,64 @@ "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "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": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the name of the Network where ip belongs to", "name": "networkname", "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": "public IP address", - "name": "ipaddress", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the project name of the address", - "name": "project", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + {}, + { + "description": "public IP address id", + "name": "id", "type": "string" } ] @@ -24021,18 +24550,18 @@ "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" } @@ -24040,40 +24569,40 @@ "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ { - "description": "the username to authenticate to the controller", - "name": "username", + "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 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" }, + {}, + {}, { "description": "the url of the controller api", "name": "url", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device id of the controller", - "name": "id", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "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" } ] @@ -24091,60 +24620,65 @@ "type": "string" }, { - "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": "string" + "type": "uuid" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, - "name": "username", + "name": "nat", "required": true, - "type": "string" + "type": "boolean" }, { - "description": "NAT support of the BigSwitch BCF Controller.", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", "length": 255, - "name": "nat", + "name": "hostname", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the Physical Network ID", + "description": "Username of the BigSwitch BCF Controller.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listBigSwitchBcfDevices", "response": [ + { + "description": "the controller Ip address", + "name": "hostname", + "type": "string" + }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { @@ -24152,27 +24686,22 @@ "name": "nat", "type": "boolean" }, - { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - }, + {}, + {}, { "description": "the controller password", "name": "password", "type": "string" }, - {}, - {}, { - "description": "the controller username", - "name": "username", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.6.0" @@ -24202,89 +24731,90 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the group ID of the virtual machine", + "name": "groupid", "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": "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": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "User VM type", + "name": "vmtype", "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { "description": "Guest vm Boot Mode", @@ -24292,28 +24822,48 @@ "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -24321,51 +24871,36 @@ "name": "securitygroup", "response": [ { - "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 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -24374,28 +24909,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -24404,8 +24939,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -24421,15 +24956,30 @@ "name": "endport", "type": "integer" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" @@ -24440,86 +24990,126 @@ "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "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": "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": "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", + "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 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": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -24528,98 +25118,63 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" } ], "type": "set" }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "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 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 project id of the group", + "name": "projectid", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -24628,314 +25183,172 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "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 ip address of the nic", - "name": "ipaddress", - "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 IPv6 address of network", - "name": "ip6address", - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ], - "type": "set" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "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": "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 list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "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 type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the VM's primary IP address", @@ -24943,79 +25356,53 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Base64 string containing the user data", + "name": "userdata", "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "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": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, - {}, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -25024,273 +25411,420 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the 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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "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", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "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", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", "type": "date" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the 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", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 domain associated with the tag", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the description of the affinity group", + "name": "description", "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": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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": "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 traffic type of the nic", + "name": "traffictype", + "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": "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": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" } ] }, @@ -25317,44 +25851,44 @@ ], "related": "executeClusterDrsPlan", "response": [ + {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, + {}, { "description": "Start event Id of the DRS Plan", "name": "eventid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, - {}, { "description": "List of migrations", "name": "migrations", "type": "list" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -25378,6 +25912,17 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -25388,17 +25933,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" } ] }, @@ -25418,7 +25952,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" }, @@ -25433,70 +25967,70 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "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", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "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 driver for the host", + "name": "driver", "type": "string" }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, { "description": "the operation result", "name": "status", "type": "boolean" }, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "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 address", - "name": "address", + "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 password", + "name": "password", "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 interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" } ], @@ -25508,19 +26042,27 @@ "name": "createSharedFileSystem", "params": [ { - "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "description": "the description for the shared filesystem.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "min iops", + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", "length": 255, - "name": "miniops", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "long" + "type": "uuid" }, { "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", @@ -25530,27 +26072,20 @@ "type": "string" }, { - "description": "the description for the shared filesystem.", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "description", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively", + "description": "the zone id.", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, - { - "description": "the name of the shared filesystem.", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "max iops", "length": 255, @@ -25559,9 +26094,9 @@ "type": "long" }, { - "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", + "description": "the name of the shared filesystem.", "length": 255, - "name": "filesystem", + "name": "name", "required": true, "type": "string" }, @@ -25573,27 +26108,18 @@ "type": "string" }, { - "description": "the zone id.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the size of the shared filesystem in GiB", + "description": "min iops", "length": 255, - "name": "size", + "name": "miniops", "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 filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "filesystem", + "required": true, + "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.", @@ -25610,60 +26136,115 @@ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" + }, + { + "description": "the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" } ], "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, {}, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the filesystem format", @@ -25671,74 +26252,53 @@ "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": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" }, { "description": "path to mount the shared filesystem", "name": "path", "type": "string" }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, { "description": "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": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { @@ -25747,99 +26307,47 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the traffic type of the nic", + "name": "traffictype", "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", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -25848,43 +26356,13 @@ "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -25893,18 +26371,23 @@ "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 broadcast uri of the nic", - "name": "broadcasturi", + "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 ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -25913,28 +26396,18 @@ "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, { "description": "the ID of the corresponding network", "name": "networkid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -25943,29 +26416,29 @@ "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": "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the gateway of IPv6 network", @@ -25973,66 +26446,101 @@ "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 IPv6 address of network", - "name": "ip6address", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "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": "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" } ], "type": "list" }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "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 shared filesystem's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { @@ -26041,13 +26549,39 @@ "type": "long" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "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": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + {}, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" } ], @@ -26062,17 +26596,13 @@ "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "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", @@ -26084,12 +26614,16 @@ "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -26097,6 +26631,20 @@ "isasync": false, "name": "updateImageStore", "params": [ + { + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "length": 255, + "name": "readonly", + "required": false, + "type": "boolean" + }, + { + "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, { "description": "Image Store UUID", "length": 255, @@ -26111,32 +26659,19 @@ "name": "name", "required": false, "type": "string" - }, - { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", - "length": 255, - "name": "readonly", - "required": false, - "type": "boolean" - }, - { - "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "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 provider name of the image store", - "name": "providername", + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -26145,62 +26680,61 @@ "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", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the total disk size of the host", "name": "disksizetotal", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {}, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, - {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "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" - }, - {} + } ], "since": "4.15.0" }, @@ -26209,14 +26743,6 @@ "isasync": true, "name": "assignToLoadBalancerRule", "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", - "required": true, - "type": "uuid" - }, { "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", "length": 255, @@ -26225,6 +26751,14 @@ "since": "4.4", "type": "map" }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + }, { "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", "length": 255, @@ -26235,27 +26769,27 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -26265,33 +26799,40 @@ "name": "listAsyncJobs", "params": [ { - "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": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "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,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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "The id of the management server", @@ -26302,128 +26843,121 @@ "since": "4.19", "type": "uuid" }, - { - "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" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "isrecursive", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "queryAsyncJobResult", "response": [ { - "description": "the domain id that executed the async command", - "name": "domainid", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, - {}, { - "description": "the account that executed the async command", - "name": "account", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", + "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 completed date of the job", "name": "completed", "type": "date" }, + { + "description": "the domain id that executed the async command", + "name": "domainid", + "type": "string" + }, { "description": "the user that executed the async command", "name": "userid", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the async command executed", + "name": "cmd", + "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", "type": "integer" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, + {}, { "description": "the msid of the management server on which the job is running", "name": "managementserverid", "type": "long" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the result type", "name": "jobresulttype", "type": "string" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "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 unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, - {}, { - "description": "the async command executed", - "name": "cmd", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -26433,12 +26967,11 @@ "name": "archiveAlerts", "params": [ { - "description": "the IDs of the alerts", + "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": "ids", - "related": "listAlerts,listAlertTypes", + "name": "enddate", "required": false, - "type": "list" + "type": "date" }, { "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -26455,36 +26988,37 @@ "type": "string" }, { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the alerts", "length": 255, - "name": "enddate", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, - "type": "date" + "type": "list" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -26503,26 +27037,26 @@ ], "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": "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" } ] }, @@ -26532,16 +27066,16 @@ "name": "createSecondaryStorageSelector", "params": [ { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "The name identifying the heuristic rule.", "length": 255, - "name": "type", + "name": "name", "required": true, "type": "string" }, { - "description": "The description of 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": "description", + "name": "type", "required": true, "type": "string" }, @@ -26561,9 +27095,9 @@ "type": "uuid" }, { - "description": "The name identifying the heuristic rule.", + "description": "The description of the heuristic rule.", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" } @@ -26571,16 +27105,20 @@ "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ { - "description": "Description of the heuristic.", - "name": "description", + "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" + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "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", @@ -26592,13 +27130,8 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { @@ -26608,20 +27141,21 @@ }, {}, { - "description": "Name of the heuristic.", - "name": "name", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "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": "When the heuristic was removed.", - "name": "removed", + "description": "When the heuristic was created.", + "name": "created", "type": "date" - } + }, + {} ], "since": "4.19.0" }, @@ -26639,64 +27173,64 @@ "type": "uuid" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "Hostname of ip address of the Brocade VCS Switch.", "length": 255, - "name": "password", + "name": "hostname", "required": true, "type": "string" }, { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" } ], "related": "listBrocadeVcsDevices", "response": [ + {}, + {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" } ] @@ -26707,11 +27241,11 @@ "name": "deleteTags", "params": [ { - "description": "Delete tags matching key/value pairs", + "description": "Delete tags for resource id(s)", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "resourceids", + "required": true, + "type": "list" }, { "description": "Delete tag by resource type", @@ -26721,35 +27255,35 @@ "type": "string" }, { - "description": "Delete tags for resource id(s)", + "description": "Delete tags matching key/value pairs", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "name": "tags", + "required": false, + "type": "map" } ], "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" } ], "since": "4.0.0" @@ -26759,13 +27293,6 @@ "isasync": true, "name": "createTungstenFabricTagType", "params": [ - { - "description": "Tungsten-Fabric tag type name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -26773,21 +27300,23 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric tag type name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listTungstenFabricTagType", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", @@ -26798,15 +27327,20 @@ "name": "zonename", "type": "string" }, + { + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" } ] @@ -26823,13 +27357,6 @@ "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": "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, @@ -26843,18 +27370,20 @@ "name": "domainId", "required": false, "type": "long" + }, + { + "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" } ], - "related": "oauthlogin", + "related": "samlSso,oauthlogin", "response": [ { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" - }, - { - "description": "User ID", - "name": "userid", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { @@ -26862,35 +27391,25 @@ "name": "lastname", "type": "string" }, - { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" - }, - { - "description": "Is user registered", - "name": "registered", - "type": "string" - }, {}, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { @@ -26904,40 +27423,55 @@ "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, - { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "Is user registered", + "name": "registered", + "type": "string" + }, + { + "description": "the account name the user belongs to", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -26947,19 +27481,19 @@ "name": "restartNetwork", "params": [ { - "description": "Turn the network into a network with redundant routers.", + "description": "The ID of the network to restart.", "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" + "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.", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "livepatch", + "name": "makeredundant", "required": false, - "since": "4.17.0", + "since": "4.11.1", "type": "boolean" }, { @@ -26970,36 +27504,36 @@ "type": "boolean" }, { - "description": "The ID of the network to restart.", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "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" + }, {} ] }, @@ -27009,19 +27543,11 @@ "name": "listHypervisorCapabilities", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "ID of the hypervisor capability", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -27038,72 +27564,80 @@ "type": "string" }, { - "description": "List by keyword", + "description": "ID of the hypervisor capability", "length": 255, - "name": "keyword", + "name": "id", + "related": "listHypervisorCapabilities", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ {}, + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" + }, { "description": "the maximum number of guest vms recommended for this hypervisor", "name": "maxguestslimit", "type": "long" }, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "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", - "type": "string" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, { "description": "the hypervisor version", "name": "hypervisorversion", "type": "string" }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - }, - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, { "description": "the maximum number of Data Volumes that can be attached for this hypervisor", "name": "maxdatavolumeslimit", "type": "integer" }, + {}, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", + "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", - "type": "string" + "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" + } ], "since": "3.0.0" }, @@ -27136,8 +27670,8 @@ "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" }, {}, @@ -27146,12 +27680,12 @@ "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.15.0" }, @@ -27171,26 +27705,26 @@ "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": "variable", "name": "variable", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "description", "name": "description", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], "since": "4.20" @@ -27200,6 +27734,14 @@ "isasync": false, "name": "quotaBalance", "params": [ + { + "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + }, { "description": "Start of the period of the Quota balance. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, @@ -27222,14 +27764,6 @@ "required": false, "type": "uuid" }, - { - "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" - }, { "description": "Account Id for which statement needs to be generated", "length": 255, @@ -27241,29 +27775,36 @@ "related": "quotaStatement", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usage type name", + "name": "name", "type": "string" }, { - "description": "usage type", - "name": "type", - "type": "int" + "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": "account id", "name": "accountid", "type": "long" }, { - "description": "usage type name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "usage unit", + "name": "unit", + "type": "string" }, { "description": "account name", @@ -27276,17 +27817,10 @@ "type": "long" }, { - "description": "usage unit", - "name": "unit", - "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" + } ], "since": "4.7.0" }, @@ -27312,23 +27846,23 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "SolidFire Account ID", "name": "solidFireAccountId", "type": "long" - }, - {} + } ] }, { @@ -27347,48 +27881,48 @@ ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + }, { "description": "the description of the role permission", "name": "description", "type": "string" }, + {}, { "description": "the name of the role to which the role permission belongs", "name": "rolename", "type": "string" }, - { - "description": "the ID of the role permission", - "name": "id", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the permission type of the api name or wildcard rule, allow/deny", "name": "permission", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { "description": "the api name or wildcard rule", "name": "rule", "type": "string" - } + }, + {} ], "since": "4.9.0" }, @@ -27398,127 +27932,132 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "zone of the guest VLAN range", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "physical network id of the guest VLAN range", + "description": "the dedicated guest vlan range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "project who will own the guest VLAN range", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list dedicated guest vlan ranges by id", + "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": "id", - "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "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" }, { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "zone of the guest VLAN range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the dedicated guest vlan range", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "guestvlanrange", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, - "type": "string" + "type": "uuid" } ], "related": "dedicateGuestVlanRange", "response": [ - {}, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "description": "the guest VLAN range", + "name": "guestvlanrange", + "type": "string" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "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": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, { "description": "the zone of the guest vlan range", "name": "zoneid", "type": "long" }, + {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, { @@ -27528,13 +28067,8 @@ }, {}, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -27545,32 +28079,42 @@ "name": "listNetworkACLs", "params": [ { - "description": "list network ACL items by action", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "action", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" + }, + { + "description": "list network ACL items by protocol", + "length": 255, + "name": "protocol", "required": false, "type": "string" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list network ACL items by network ID", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list network ACL items by protocol", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "protocol", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list network ACL items by traffic type - ingress or egress", @@ -27580,41 +28124,40 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "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": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 network ACL items by action", "length": 255, - "name": "listall", + "name": "action", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network ACL items by ACL ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List by keyword", @@ -27624,19 +28167,11 @@ "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": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -27647,112 +28182,51 @@ "type": "uuid" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACL items by network ID", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" } ], "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, {}, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "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 name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the protocol of the ACL", "name": "protocol", "type": "string" }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -27761,13 +28235,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -27776,8 +28250,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -27786,13 +28260,38 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the 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", @@ -27800,19 +28299,54 @@ }, {}, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" } ] }, @@ -27822,20 +28356,20 @@ "name": "copyTemplate", "params": [ { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "Template ID.", "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,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.", + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", "length": 255, - "name": "sourcezoneid", + "name": "destzoneids", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "type": "list" }, { "description": "ID of the zone the template is being copied to.", @@ -27846,59 +28380,105 @@ "type": "uuid" }, { - "description": "Template ID.", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "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, + "name": "sourcezoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ + {}, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, { "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", + "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 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", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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" }, { @@ -27907,33 +28487,53 @@ "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "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 managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { @@ -27942,53 +28542,103 @@ "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the status of the template", - "name": "status", + "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", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "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": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, { "description": "the ID of the secondary storage host for the template", "name": "hostid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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 name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { @@ -27996,29 +28646,23 @@ "name": "userdataname", "type": "string" }, - {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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" }, { @@ -28027,8 +28671,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -28042,158 +28686,48 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "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 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": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "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 template ID", - "name": "id", - "type": "string" - }, - { - "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": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "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", - "type": "string" } ] }, @@ -28203,11 +28737,11 @@ "name": "listNiciraNvpDeviceNetworks", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -28217,11 +28751,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "nicira nvp device ID", @@ -28235,64 +28769,85 @@ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, + {}, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "the name of the Network associated with this private gateway", @@ -28300,44 +28855,89 @@ "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "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": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", + "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 network", "name": "associatednetworkid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -28346,18 +28946,68 @@ "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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", + "type": "string" + }, + { + "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": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { @@ -28366,23 +29016,68 @@ "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -28390,139 +29085,114 @@ "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the provider name", "name": "name", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + }, { - "description": "the capability name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "state of the network provider", + "name": "state", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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" }, { @@ -28531,13 +29201,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -28546,13 +29216,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -28561,102 +29231,61 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "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 BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the 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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, - {}, { - "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" }, { @@ -28665,104 +29294,14 @@ "type": "set" }, { - "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": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "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 name of the network", - "name": "name", - "type": "string" - }, { "description": "Broadcast domain type of the network", "name": "broadcastdomaintype", "type": "string" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" - }, - { - "description": "the id of the network", - "name": "id", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "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 IPv4 routing type of network", - "name": "ip4routing", - "type": "string" } ] }, @@ -28781,28 +29320,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": "the current status of the latest async job 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.6.0" }, @@ -28812,109 +29351,109 @@ "name": "listOvsElements", "params": [ { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list network offerings by enabled state", "length": 255, - "name": "keyword", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list ovs elements by network service provider id", + "description": "list ovs elements by id", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list ovs elements by id", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, "type": "uuid" } ], "related": "configureOvsElement", "response": [ + { + "description": "the account associated with the provider", + "name": "account", + "type": "string" + }, { "description": "the physical network service provider id of the provider", "name": "nspid", "type": "string" }, - {}, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the id of the ovs", + "name": "id", + "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, + {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 project id of the ipaddress", "name": "projectid", "type": "string" - }, - { - "description": "the id of the ovs", - "name": "id", - "type": "string" - }, - {} + } ] }, { @@ -28923,19 +29462,19 @@ "name": "associateUcsProfileToBlade", "params": [ { - "description": "blade id", + "description": "profile dn", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "profiledn", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "profile dn", + "description": "blade id", "length": 255, - "name": "profiledn", + "name": "bladeid", + "related": "associateUcsProfileToBlade", "required": true, - "type": "string" + "type": "uuid" }, { "description": "ucs manager id", @@ -28949,29 +29488,23 @@ "related": "", "response": [ { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, - {}, { - "description": "ucs blade id", - "name": "id", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "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", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { @@ -28980,6 +29513,12 @@ "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", @@ -29001,26 +29540,26 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -29031,20 +29570,6 @@ "isasync": false, "name": "updateVmwareDc", "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": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "The username required to connect to resource.", "length": 255, @@ -29053,11 +29578,11 @@ "type": "string" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "description": "VMware datacenter name.", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The zone ID", @@ -29068,21 +29593,44 @@ "type": "uuid" }, { - "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.", + "length": 255, + "name": "vcenter", "required": false, "type": "string" + }, + { + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -29093,21 +29641,12 @@ "name": "id", "type": "string" }, + {}, + {}, { "description": "The VMware Datacenter name", "name": "name", "type": "string" - }, - {}, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.12.0" @@ -29135,27 +29674,27 @@ ], "related": "", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "routerid", "type": "string" }, { - "description": "the id of the router", - "name": "healthchecks", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the id of the router", - "name": "routerid", - "type": "string" + "name": "healthchecks", + "type": "list" } ], "since": "4.14.0" @@ -29165,13 +29704,6 @@ "isasync": false, "name": "listNetscalerControlCenter", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -29185,6 +29717,13 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", @@ -29194,38 +29733,38 @@ "name": "username", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ncc_ip", + "name": "ipaddress", + "type": "string" }, { "description": "num_retries", "name": "numretries", "type": "string" }, - {}, { "description": "id", "name": "id", "type": "string" }, - { - "description": "ncc_ip", - "name": "ipaddress", - "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" + } ] }, { @@ -29234,26 +29773,26 @@ "name": "resizeVolume", "params": [ { - "description": "the ID of the disk volume", + "description": "new disk offering id", "length": 255, - "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, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, "type": "uuid" }, { - "description": "New maximum number of IOPS", + "description": "Verify OK to Shrink", "length": 255, - "name": "maxiops", + "name": "shrinkok", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "New maximum number of IOPS", "length": 255, - "name": "shrinkok", + "name": "maxiops", "required": false, - "type": "boolean" + "type": "long" }, { "description": "New volume size in GB", @@ -29263,126 +29802,131 @@ "type": "long" }, { - "description": "New minimum number of IOPS", + "description": "the ID of the disk volume", "length": 255, - "name": "miniops", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + }, + { + "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", + "length": 255, + "name": "automigrate", "required": false, - "type": "long" + "since": "4.20.1", + "type": "boolean" }, { - "description": "new disk offering id", + "description": "New minimum number of IOPS", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "miniops", "required": false, - "type": "uuid" + "type": "long" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "name of the availability zone", - "name": "zonename", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, + {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "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": "ID of the disk volume", - "name": "id", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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": "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": "the path of the volume", - "name": "path", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { @@ -29391,197 +29935,139 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 bytes actually consumed on disk", - "name": "physicalsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the display text of the service offering for root disk", @@ -29589,120 +30075,181 @@ "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, { "description": "true if volume has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" } ] }, @@ -29712,27 +30259,28 @@ "name": "deleteAffinityGroup", "params": [ { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the project of the affinity group", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the project of the affinity group", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "the domain ID of account owning the affinity group", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the account of the affinity group. Must be specified with domain ID", @@ -29742,36 +30290,35 @@ "type": "string" }, { - "description": "the domain ID of account owning the affinity group", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "name", "required": false, - "type": "uuid" + "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": "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" } ] }, @@ -29790,163 +30337,170 @@ } ], "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ], "since": "3.0.0" }, { - "description": "Dedicates a Pod.", + "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", "isasync": true, - "name": "dedicatePod", + "name": "updateStorageNetworkIpRange", "params": [ { - "description": "the ID of the containing domain", + "description": "the ending IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the ID of the Pod", + "description": "UUID of storage network ip range", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", "required": true, "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "Optional. the vlan the ip range sits on", "length": 255, - "name": "account", + "name": "vlan", + "required": false, + "type": "integer" + }, + { + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", "required": false, "type": "string" } ], - "related": "listDedicatedPods", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, + {}, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the Name of the Pod", - "name": "podname", + "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 start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" + }, + { + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "integer" }, - {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} - ] + ], + "since": "3.0.0" }, { - "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", + "description": "Dedicates a Pod.", "isasync": true, - "name": "updateStorageNetworkIpRange", + "name": "dedicatePod", "params": [ { - "description": "UUID of storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the beginning IP address", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "startip", + "name": "account", "required": false, "type": "string" }, { - "description": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" - }, - { - "description": "the ending IP address", + "description": "the ID of the Pod", "length": 255, - "name": "endip", - "required": false, - "type": "string" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the netmask for storage network", + "description": "the ID of the containing domain", "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" } ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "related": "listDedicatedPods", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { @@ -29955,44 +30509,37 @@ "type": "integer" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" } - ], - "since": "3.0.0" + ] }, { "description": "Synchronize Tungsten-Fabric data", @@ -30009,28 +30556,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "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" + } ] }, { @@ -30038,6 +30585,13 @@ "isasync": true, "name": "purgeExpungedResources", "params": [ + { + "description": "The size of batch used during purging", + "length": 255, + "name": "batchsize", + "required": false, + "type": "long" + }, { "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", "length": 255, @@ -30058,28 +30612,21 @@ "name": "startdate", "required": false, "type": "date" - }, - { - "description": "The size of batch used during purging", - "length": 255, - "name": "batchsize", - "required": false, - "type": "long" } ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "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", @@ -30098,35 +30645,14 @@ "isasync": true, "name": "changeOfferingForVolume", "params": [ - { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "type": "boolean" - }, - { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "type": "boolean" - }, { "description": "the ID of the volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" - }, { "description": "new disk offering id", "length": 255, @@ -30142,24 +30668,60 @@ "required": false, "type": "long" }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "type": "boolean" + }, + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + }, { "description": "New volume size in GB for the custom disk offering", "length": 255, "name": "size", "required": false, "type": "long" + }, + { + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "type": "boolean" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -30168,146 +30730,154 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "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", + "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": "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", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "shared or local storage", + "name": "storagetype", + "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": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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 status of the volume", + "name": "status", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "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": "id of the virtual machine", - "name": "virtualmachineid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "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", @@ -30315,23 +30885,23 @@ "type": "map" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -30339,70 +30909,121 @@ "name": "supportsstoragesnapshot", "type": "boolean" }, + {}, { - "description": "the path of the volume", - "name": "path", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "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": "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", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "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 domain associated with the tag", "name": "domain", @@ -30414,18 +31035,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { @@ -30434,13 +31050,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -30449,182 +31065,112 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "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": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" + } + ], + "since": "4.17" + }, + { + "description": "Remove an Ldap Configuration", + "isasync": false, + "name": "deleteLdapConfiguration", + "params": [ + { + "description": "port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, "type": "string" - }, + } + ], + "related": "addLdapConfiguration,listLdapConfigurations", + "response": [ { - "description": "the status of the volume", - "name": "status", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "linked domain", + "name": "domainid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - } - ], - "since": "4.17" - }, - { - "description": "Remove an Ldap Configuration", - "isasync": false, - "name": "deleteLdapConfiguration", - "params": [ - { - "description": "port", - "length": 255, - "name": "port", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - } - ], - "related": "addLdapConfiguration,listLdapConfigurations", - "response": [ - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" - }, - { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" - }, - {}, - { - "description": "linked domain", - "name": "domainid", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -30632,10 +31178,11 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "port the ldap server is running on", + "name": "port", + "type": "int" + }, + {} ], "since": "4.2.0" }, @@ -30651,6 +31198,13 @@ "required": true, "type": "string" }, + { + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "ID of project where role is being created", "length": 255, @@ -30658,54 +31212,47 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" - }, - { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "listProjectRoles,updateProjectRole", "response": [ { - "description": "the ID of the role", - "name": "id", + "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": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the role", - "name": "name", + "description": "the ID of the role", + "name": "id", "type": "string" }, + {}, + {}, { "description": "the id of the project", "name": "projectid", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the role", - "name": "description", + "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" }, @@ -30714,13 +31261,6 @@ "isasync": true, "name": "createIpv6FirewallRule", "params": [ - { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, { "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, @@ -30729,47 +31269,46 @@ "type": "string" }, { - "description": "error code for this ICMP message", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, { - "description": "The network of the VM the Ipv6 firewall rule will be created for", + "description": "type of the ICMP message being sent", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "endport", + "name": "fordisplay", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "icmptype", + "name": "endport", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "error code for this ICMP message", "length": 255, - "name": "fordisplay", + "name": "icmpcode", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "startport", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", @@ -30779,18 +31318,31 @@ "type": "list" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" } ], - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -30799,35 +31351,40 @@ "type": "string" }, { - "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" }, {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { "description": "the starting port of port forwarding rule's private port range", "name": "privateport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -30835,23 +31392,58 @@ "name": "fordisplay", "type": "boolean" }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, { "description": "the public ip address id for the port forwarding rule", "name": "ipaddressid", "type": "string" }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -30860,23 +31452,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": "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": "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" }, { @@ -30885,62 +31477,17 @@ "type": "string" }, { - "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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the 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" } ] }, @@ -30961,9 +31508,9 @@ "related": "cancelShutdown,prepareForShutdown,readyForShutdown", "response": [ { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, {}, { @@ -30971,26 +31518,26 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "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 id of the management server", + "name": "managementserverid", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" } ], "since": "4.19.0" @@ -31001,94 +31548,85 @@ "name": "updateNetwork", "params": [ { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", "length": 255, - "name": "ip6dns1", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", - "length": 255, - "name": "hideipaddressusage", - "required": false, - "type": "boolean" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "displaynetwork", + "name": "guestvmcidr", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Force update even if CIDR type is different", + "description": "the new display text for the network", "length": 255, - "name": "changecidr", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the new name for the network", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "network offering ID", + "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": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "updateinsequence", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "sourcenatipaddress", + "name": "hideipaddressusage", "required": false, - "since": "4.19", - "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 new name for the network", "length": 255, - "name": "dns1", + "name": "name", "required": false, - "since": "4.18.0", "type": "string" }, { - "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": "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, whether to the display the network to the end user or not.", "length": 255, - "name": "dns2", + "name": "displaynetwork", "required": false, - "since": "4.18.0", - "type": "string" + "type": "boolean" }, { - "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 ID of the network", "length": 255, - "name": "updateinsequence", - "required": false, - "type": "boolean" + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "network domain", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "networkdomain", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { "description": "Setting this to true will cause a forced network update,", @@ -31098,82 +31636,106 @@ "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 first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", "length": 255, - "name": "customid", + "name": "ip6dns1", "required": false, - "since": "4.4", + "since": "4.18.0", "type": "string" }, { - "description": "the new display text for the network", + "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", "length": 255, - "name": "displaytext", + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "guestvmcidr", + "name": "changecidr", + "required": false, + "type": "boolean" + }, + { + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "length": 255, + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "the ID of the network", + "description": "network offering ID", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, "type": "uuid" }, { "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "publicmtu", + "name": "privatemtu", "required": false, "since": "4.18.0", "type": "integer" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "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": "privatemtu", + "name": "dns2", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -31182,229 +31744,309 @@ "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 ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, { "description": "the traffic type of the network", "name": "traffictype", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "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 project name of the address", - "name": "project", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, + {}, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "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": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "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": "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 first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, { - "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 IPv4 routing type of network", - "name": "ip4routing", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the owner of the network", + "name": "account", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "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", + "description": "the provider name", "name": "name", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -31413,24 +32055,19 @@ "type": "list" }, { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "type": "list" @@ -31439,43 +32076,65 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { @@ -31484,199 +32143,287 @@ "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, + {}, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { "description": "the name of the network", "name": "name", "type": "string" }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, { "description": "the name of the Network associated with this private gateway", "name": "associatednetwork", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ] + }, + { + "description": "Lists VM backups", + "isasync": false, + "name": "listBackups", + "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", + "required": false, + "type": "integer" + }, + { + "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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "id of the backup", + "length": 255, + "name": "id", + "related": "updateBackupSchedule,listBackups", + "required": false, + "type": "uuid" + }, + { + "description": "list backups by zone id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "id of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "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": "updateBackupSchedule", + "response": [ + { + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "the domain id of the network owner", + "description": "backup size in bytes", + "name": "size", + "type": "long" + }, + { + "description": "domain id", "name": "domainid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "zone id", + "name": "zoneid", + "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "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": "ID of the VM backup", + "name": "id", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "backup status", + "name": "status", + "type": "status" + }, + {}, + { + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "zone name", + "name": "zone", "type": "string" }, + {}, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "ID of the VM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "backup offering id", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "account id", + "name": "accountid", + "type": "string" + }, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "backup date", + "name": "created", + "type": "date" + }, + { + "description": "backed up volumes", + "name": "volumes", + "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 network", - "name": "dns1", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "domain name", + "name": "domain", + "type": "string" } - ] + ], + "since": "4.14.0" }, { "description": "List Usage Types", @@ -31685,16 +32432,54 @@ "params": [], "related": "", "response": [ + {}, + {}, + { + "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", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Usage type name", "name": "name", "type": "string" + } + ] + }, + { + "description": "Lists Backup and Recovery providers", + "isasync": false, + "name": "listBackupProviders", + "params": [ + { + "description": "List Backup and Recovery provider by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the CA service provider name", + "name": "name", + "type": "string" }, {}, { @@ -31702,17 +32487,19 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Usage type description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the CA service provider", + "name": "description", "type": "string" } - ] + ], + "since": "4.14.0" }, { "description": "Deletes a VPC", @@ -31729,18 +32516,12 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -31750,7 +32531,13 @@ "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" + }, + {} ] }, { @@ -31766,6 +32553,14 @@ "required": true, "type": "uuid" }, + { + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, { "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", "length": 255, @@ -31778,15 +32573,7 @@ "description": "Destination Host ID to migrate VM to.", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" } @@ -31794,115 +32581,23 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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": "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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "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 userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -31911,53 +32606,53 @@ "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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 type of the affinity group", + "name": "type", + "type": "string" }, { "description": "the account owning the affinity group", @@ -31965,9 +32660,9 @@ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { "description": "the description of the affinity group", @@ -31975,162 +32670,21 @@ "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "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 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", - "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", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - {}, - { - "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { @@ -32139,33 +32693,18 @@ "type": "map" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "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", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -32173,28 +32712,28 @@ "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -32203,83 +32742,61 @@ "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", - "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -32288,13 +32805,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -32303,18 +32820,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -32323,107 +32845,72 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "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 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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of 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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "tag value", + "name": "value", "type": "string" }, { @@ -32437,47 +32924,42 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "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" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the protocol of the security group rule", @@ -32485,115 +32967,191 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "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": "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 virtual machine", - "name": "name", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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 backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -32602,148 +33160,312 @@ "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "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 virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the project name where tag belongs to", + "name": "project", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "id of the resource", + "name": "resourceid", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the 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": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "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": "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": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "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": "true if nic is default, false otherwise", + "name": "macaddress", "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -32756,18 +33478,28 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "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" }, { @@ -32776,14 +33508,14 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "MTU configured on the NIC", @@ -32791,73 +33523,113 @@ "type": "integer" }, { - "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 gateway of the nic", - "name": "gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "the ip address of the nic", "name": "ipaddress", "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "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": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { "description": "the incoming network traffic on the VM in KiB", @@ -32865,23 +33637,43 @@ "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ] @@ -32902,26 +33694,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + { + "description": "the current status of the latest async job 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" - }, - {}, {} ] }, @@ -32933,7 +33725,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -32947,34 +33739,34 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "addBaremetalRct", "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": "url", - "name": "url", - "type": "string" - }, { "description": "id of rct", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url", + "name": "url", "type": "string" }, - {}, {} ] }, @@ -32993,6 +33785,12 @@ ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the CA service provider name", "name": "name", @@ -33003,17 +33801,11 @@ "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.11.0" @@ -33039,6 +33831,12 @@ "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", @@ -33048,13 +33846,7 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -33070,41 +33862,48 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "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 only resources belonging to the domain specified", + "description": "the ID of IP address of the port forwarding services", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list port forwarding rules for certain network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { - "description": "Lists rule with the specified ID.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -33124,110 +33923,91 @@ "type": "integer" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list 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": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "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", + "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", + "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 public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { @@ -33235,23 +34015,23 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project 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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -33260,23 +34040,23 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -33285,37 +34065,49 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the 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 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 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" } ] }, @@ -33325,54 +34117,57 @@ "name": "acquirePodIpAddress", "params": [ { - "description": "the ID of the zone", + "description": "Pod ID", "length": 255, - "name": "zoneid", + "name": "podid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, "type": "string" }, { - "description": "Pod ID", + "description": "the ID of the zone", "length": 255, - "name": "podid", + "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, + "required": true, "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "the ID of the nic", + "name": "nicid", "type": "long" }, - {}, { "description": "the ID of the pod the IP address", "name": "id", "type": "long" }, { - "description": "Allocated IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the pod the IP address belongs to", + "name": "podid", "type": "long" }, { @@ -33380,16 +34175,13 @@ "name": "cidr", "type": "string" }, - { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" - }, + {}, { "description": "Gateway for Pod ", "name": "gateway", "type": "string" - } + }, + {} ] }, { @@ -33410,45 +34202,45 @@ "response": [ {}, { - "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 interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the operation result", + "name": "status", + "type": "boolean" }, + {}, { "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "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": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the ID of the host", @@ -33456,24 +34248,24 @@ "type": "string" }, { - "description": "the operation result description", - "name": "description", + "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 address", - "name": "address", + "description": "the operation result description", + "name": "description", "type": "string" }, { "description": "the out-of-band management interface port", "name": "port", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.0" @@ -33490,13 +34282,6 @@ "required": false, "type": "boolean" }, - { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "permission operator (add, remove, reset)", "length": 255, @@ -33505,12 +34290,11 @@ "type": "string" }, { - "description": "the template ID", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "accounts", + "required": false, + "type": "list" }, { "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", @@ -33521,11 +34305,11 @@ "type": "list" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "accounts", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", @@ -33533,30 +34317,38 @@ "name": "isextractable", "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": "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" } ] }, @@ -33565,14 +34357,6 @@ "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, @@ -33580,73 +34364,97 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0", + "type": "string" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, + {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "CPU arch of the VM", + "name": "arch", "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -33655,289 +34463,58 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "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": "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "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 template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - {}, - { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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 service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "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" }, { @@ -33946,328 +34523,86 @@ "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 hypervisor on which the template runs", - "name": "hypervisor", + "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", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "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 vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { "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": "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 pool type of the virtual machine", - "name": "pooltype", - "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 name of the virtual machine", - "name": "name", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 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" }, { @@ -34276,13 +34611,8 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -34295,13 +34625,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -34310,43 +34640,53 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" } ], "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 ending IP of the security group rule ", "name": "endport", @@ -34358,114 +34698,84 @@ "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, - { - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" } ], "type": "set" }, { - "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 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", @@ -34473,17 +34783,42 @@ "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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" + }, + { + "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": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the 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" }, { @@ -34491,72 +34826,67 @@ "name": "tags", "response": [ { - "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": "resource type", + "name": "resourcetype", "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "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": "customer associated with the tag", - "name": "customer", + "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 domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the code for the ICMP message response", @@ -34564,20 +34894,20 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", @@ -34585,69 +34915,94 @@ } ], "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -34656,203 +35011,645 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - } - ] - }, - { - "description": "Lists Brocade VCS Switches", - "isasync": false, - "name": "listBrocadeVcsDevices", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Brocade VCS switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "State of the Service from LB rule", + "name": "servicestate", "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" }, - {}, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - } - ] - }, - { - "description": "link an existing cloudstack domain to group or OU in ldap", - "isasync": false, - "name": "linkDomainToLdap", - "params": [ { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "The id of the domain which has to be linked to LDAP.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "type of the ldap name. GROUP or OU", - "length": 255, - "name": "type", - "required": true, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": true, - "type": "integer" - }, + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + } + ], + "type": "set" + }, { - "description": "name of the group or OU in LDAP", - "length": 255, + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the virtual machine", "name": "name", - "required": false, "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + } + ] + }, + { + "description": "Lists Brocade VCS Switches", + "isasync": false, + "name": "listBrocadeVcsDevices", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "ldapdomain", + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "Brocade VCS switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "linkAccountToLdap", + "related": "", "response": [ { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "device name", + "name": "brocadedevicename", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "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": "link an existing cloudstack domain to group or OU in ldap", + "isasync": false, + "name": "linkDomainToLdap", + "params": [ + { + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, + "type": "string" + }, { - "description": "Type of the account to auto import", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": false, + "type": "string" + }, + { + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, "name": "accounttype", - "type": "int" + "required": true, + "type": "integer" + }, + { + "description": "The id of the domain which has to be linked to LDAP.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + }, + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, + { + "description": "type of the ldap name. GROUP or OU", + "length": 255, + "name": "type", + "required": true, + "type": "string" + } + ], + "related": "linkAccountToLdap", + "response": [ { "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": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", + "type": "string" + }, + { + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", + "type": "string" + }, { "description": "id of the Domain which is linked to LDAP", "name": "domainid", "type": "string" }, + { + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", - "type": "string" + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" } ], "since": "4.6.0" @@ -34869,13 +35666,6 @@ "required": false, "type": "boolean" }, - { - "description": "two factor authentication code", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, @@ -34883,42 +35673,49 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" + }, + { + "description": "two factor authentication code", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user name", + "name": "username", + "type": "string" }, + {}, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", "type": "string" }, - {}, { - "description": "the user ID", - "name": "id", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.18.0" }, @@ -34935,14 +35732,6 @@ "required": false, "type": "uuid" }, - { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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, @@ -34958,19 +35747,19 @@ "type": "integer" }, { - "description": "id of the customer gateway", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "id of the customer gateway", "length": 255, - "name": "keyword", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -34987,9 +35776,17 @@ "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": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" } @@ -34997,13 +35794,8 @@ "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the vpn gateway ID", - "name": "id", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -35011,51 +35803,56 @@ "name": "jobid", "type": "string" }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "IPsec policy of customer gateway", "name": "esppolicy", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - {}, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { "description": "the domain id of the owner", @@ -35063,14 +35860,9 @@ "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { "description": "the date and time the host was removed", @@ -35078,13 +35870,13 @@ "type": "date" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -35093,29 +35885,34 @@ "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "name of the customer gateway", + "name": "name", "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": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, - {}, { - "description": "name of the customer gateway", - "name": "name", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, + {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ] @@ -35134,17 +35931,17 @@ "type": "uuid" }, { - "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" @@ -35157,12 +35954,6 @@ "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", @@ -35172,6 +35963,12 @@ "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" } ] }, @@ -35181,11 +35978,12 @@ "name": "listWebhooks", "params": [ { - "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": "", @@ -35202,18 +36000,11 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "The scope of the Webhook", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "scope", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The state of the Webhook", @@ -35230,11 +36021,19 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "The scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, + "type": "string" }, { "description": "The ID of the Webhook", @@ -35245,81 +36044,88 @@ "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 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" } ], "related": "createWebhook,listWebhookDeliveries", "response": [ { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, - {}, { - "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 name of the Webhook", - "name": "name", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, - {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + }, + { + "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" + "description": "The scope of the Webhook", + "name": "scope", + "type": "string" }, + {}, { - "description": "The state of the Webhook", - "name": "state", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { @@ -35328,13 +36134,13 @@ "type": "string" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -35343,22 +36149,60 @@ "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Lists and switches to other SAML accounts owned by the SAML user", + "isasync": false, + "name": "listAndSwitchSamlAccount", + "params": [ { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "Domain uuid", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "User uuid", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" } ], - "since": "4.20.0" + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] }, { "description": "Creates a global load balancer rule", @@ -35366,9 +36210,9 @@ "name": "createGlobalLoadBalancerRule", "params": [ { - "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" }, @@ -35381,9 +36225,9 @@ "type": "uuid" }, { - "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" }, @@ -35396,37 +36240,37 @@ "type": "integer" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "name of the load balancer rule", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "name of the load balancer rule", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "name", + "name": "gslbservicetype", "required": true, "type": "string" }, { - "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": "gslblbmethod", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "gslbdomainname", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "domain name for the GSLB service.", "length": 255, - "name": "gslbservicetype", + "name": "gslbdomainname", "required": true, "type": "string" } @@ -35434,44 +36278,38 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "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", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { @@ -35479,118 +36317,68 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, {}, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the project name of the load balancer", + "name": "project", "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", + "type": "string" }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -35599,47 +36387,72 @@ "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": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the public port", - "name": "publicport", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the description of the load balancer", + "name": "description", "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": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address", + "name": "publicip", + "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": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" }, { "description": "the name of the zone the load balancer rule belongs to", @@ -35651,44 +36464,75 @@ "name": "protocol", "type": "string" }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, { "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", "type": "string" } ], "type": "list" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - } + {} ] }, { @@ -35706,6 +36550,12 @@ } ], "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -35716,17 +36566,11 @@ "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" }, - {}, {} ] }, @@ -35736,19 +36580,18 @@ "name": "listTags", "params": [ { - "description": "list by resource type", + "description": "list by resource id", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list by value", @@ -35758,40 +36601,41 @@ "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list by customer name", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "customer", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list by customer name", "length": 255, - "name": "keyword", + "name": "customer", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "key", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by key", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "key", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -35801,18 +36645,18 @@ "type": "integer" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list by resource type", "length": 255, - "name": "isrecursive", + "name": "resourcetype", "required": 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.", @@ -35822,9 +36666,9 @@ "type": "boolean" }, { - "description": "list by resource id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "resourceid", + "name": "account", "required": false, "type": "string" } @@ -35832,34 +36676,28 @@ "related": "listResourceDetails", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "tag value", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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" }, { @@ -35868,35 +36706,41 @@ "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, + {}, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, - {}, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.0.0" @@ -35906,6 +36750,14 @@ "isasync": false, "name": "listAffectedVmsForStorageScopeChange", "params": [ + { + "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" + }, { "description": "the Id of the cluster the scope of the storage pool is being changed to", "length": 255, @@ -35915,33 +36767,25 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "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" + "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": "", @@ -35951,12 +36795,17 @@ "name": "clusterid", "type": "string" }, + {}, { - "description": "the hostname for the VM", - "name": "hostname", + "description": "the type of VM", + "name": "type", + "type": "string" + }, + { + "description": "the name of the VM", + "name": "name", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -35979,18 +36828,13 @@ "type": "integer" }, { - "description": "the name of the VM", - "name": "name", - "type": "string" - }, - { - "description": "the type of VM", - "name": "type", + "description": "the host ID for the VM", + "name": "hostid", "type": "string" }, { - "description": "the host ID for the VM", - "name": "hostid", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" } ], @@ -36020,22 +36864,6 @@ ], "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ - { - "description": "the id of the router", - "name": "id", - "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 physical network service provider id of the provider", "name": "nspid", @@ -36047,8 +36875,14 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "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" }, { @@ -36056,9 +36890,15 @@ "name": "enabled", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { @@ -36066,15 +36906,19 @@ "name": "domainpath", "type": "string" }, - {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" } ] @@ -36085,25 +36929,24 @@ "name": "createVPC", "params": [ { - "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 name of the VPC", "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "name": "name", + "required": true, "type": "string" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "the second IPv6 DNS for the VPC", "length": 255, - "name": "fordisplay", + "name": "ip6dns2", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "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" @@ -36117,24 +36960,27 @@ "type": "boolean" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "cidr", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "description": "the AS Number of the VPC tiers", "length": 255, - "name": "displaytext", + "name": "asnumber", "required": false, - "type": "string" + "since": "4.20.0", + "type": "long" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "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": "networkdomain", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { @@ -36146,68 +36992,67 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the first IPv4 DNS for the VPC", "length": 255, - "name": "publicmtu", + "name": "dns1", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "the AS Number of the VPC tiers", + "description": "create VPC for the project", "length": 255, - "name": "asnumber", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.20.0", - "type": "long" + "type": "uuid" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "account", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "the first IPv4 DNS for the VPC", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "dns1", + "name": "networkdomain", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "Ids of the Bgp Peer for the VPC", + "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": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.20.0", - "type": "list" + "type": "uuid" }, { - "description": "the ID of the VPC offering", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "create VPC for the project", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "Ids of the Bgp Peer for the VPC", "length": 255, - "name": "dns2", + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.20.0", + "type": "list" }, { "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", @@ -36218,83 +37063,77 @@ "type": "integer" }, { - "description": "the first IPv6 DNS for the VPC", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "ip6dns1", + "name": "cidr", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the name of the VPC", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "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 ID of the VPC offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, "type": "uuid" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "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": "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" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "the provider name", @@ -36306,31 +37145,41 @@ "name": "destinationphysicalnetworkid", "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", + "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", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { @@ -36345,23 +37194,8 @@ "type": "list" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -36369,34 +37203,19 @@ "name": "distributedvpcrouter", "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": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, { "description": "the cidr the VPC", "name": "cidr", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { @@ -36404,140 +37223,74 @@ "name": "bgppeers", "type": "set" }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, {}, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, { "description": "the second IPv4 DNS for the VPC", "name": "dns2", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "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 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" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -36549,13 +37302,94 @@ "type": "list" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + {}, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "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 name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { @@ -36564,14 +37398,24 @@ "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the project name of the VPC", + "name": "project", "type": "string" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" } ] }, @@ -36581,10 +37425,10 @@ "name": "removeResourceDetail", "params": [ { - "description": "Delete detail by resource type", + "description": "Delete details matching key/value pairs", "length": 255, - "name": "resourcetype", - "required": true, + "name": "key", + "required": false, "type": "string" }, { @@ -36595,36 +37439,36 @@ "type": "string" }, { - "description": "Delete details matching key/value pairs", + "description": "Delete detail by resource type", "length": 255, - "name": "key", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" } ], "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -36641,19 +37485,20 @@ "type": "uuid" }, { - "description": "", + "description": "list by Os Category id", "length": 255, - "name": "page", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list os by description", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "description", + "name": "fordisplay", "required": false, - "since": "3.0.1", - "type": "string" + "since": "4.18.1", + "type": "boolean" }, { "description": "", @@ -36663,37 +37508,30 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "list os by description", "length": 255, - "name": "keyword", + "name": "description", "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "string" }, { - "description": "list by Os Category id", + "description": "", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "addGuestOs", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -36704,9 +37542,10 @@ "name": "oscategoryid", "type": "string" }, + {}, { - "description": "the ID of the OS type", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -36714,11 +37553,22 @@ "name": "oscategoryname", "type": "string" }, + {}, + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + }, { "description": "the name/description of the OS type", "name": "description", "type": "string" }, + { + "description": "the name of the OS type", + "name": "name", + "type": "string" + }, { "description": "is the guest OS user defined", "name": "isuserdefined", @@ -36728,13 +37578,7 @@ "description": "is the guest OS visible for the users", "name": "fordisplay", "type": "boolean" - }, - { - "description": "the name of the OS type", - "name": "name", - "type": "string" - }, - {} + } ] }, { @@ -36753,10 +37597,11 @@ ], "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", @@ -36764,11 +37609,10 @@ }, {}, { - "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", @@ -36782,14 +37626,6 @@ "isasync": true, "name": "detachIso", "params": [ - { - "description": "If true, ejects the ISO before detaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" - }, { "description": "The ID of the virtual machine", "length": 255, @@ -36797,182 +37633,321 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "If true, ejects the ISO before detaching on VMware. Default: false", + "length": 255, + "name": "forced", + "required": false, + "since": "4.15.1", + "type": "boolean" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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 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": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, { "description": "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "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 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -36981,28 +37956,28 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -37011,77 +37986,112 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "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 account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the 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" + }, + { + "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 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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -37090,8 +38100,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37105,18 +38115,38 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -37126,240 +38156,217 @@ "description": "the protocol of the security group rule", "name": "protocol", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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 project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "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 account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "Guest vm Boot Type", - "name": "boottype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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": "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the disk 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": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "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 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": "Guest vm Boot Type", + "name": "boottype", "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", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "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", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { @@ -37367,105 +38374,53 @@ "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, { "description": "the ID of the affinity group", "name": "id", "type": "string" - } - ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "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" } @@ -37473,288 +38428,217 @@ "type": "set" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "customer associated with the tag", + "name": "customer", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicip", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -37762,63 +38646,43 @@ "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -37827,69 +38691,54 @@ "type": "long" }, { - "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + {}, { - "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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": "the group name of the virtual machine", - "name": "group", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" } ] @@ -37910,8 +38759,8 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -37920,15 +38769,15 @@ "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" } ] @@ -37939,23 +38788,24 @@ "name": "executeWebhookDelivery", "params": [ { - "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", + "description": "The ID of the Webhook", "length": 255, - "name": "sslverification", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Payload of the Webhook delivery", + "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", "length": 255, - "name": "payload", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Payload URL of the Webhook delivery", + "description": "Secret key of the Webhook delivery", "length": 255, - "name": "payloadurl", + "name": "secretkey", "required": false, "type": "string" }, @@ -37968,43 +38818,31 @@ "type": "uuid" }, { - "description": "Secret key of the Webhook delivery", + "description": "Payload URL of the Webhook delivery", "length": 255, - "name": "secretkey", + "name": "payloadurl", "required": false, "type": "string" }, { - "description": "The ID of the Webhook", + "description": "Payload of the Webhook delivery", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "payload", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "The start time of the Webhook delivery", - "name": "startdate", - "type": "date" - }, - { - "description": "The headers of the webhook delivery", - "name": "headers", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The end time of the Webhook delivery", - "name": "enddate", - "type": "date" + "description": "The headers of the webhook delivery", + "name": "headers", + "type": "string" }, { "description": "The name of the Webhook", @@ -38012,34 +38850,45 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The type of the event", + "name": "eventtype", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "webhookid", - "type": "string" + "description": "The start time of the Webhook delivery", + "name": "startdate", + "type": "date" }, + {}, { "description": "The ID of the event", "name": "eventid", "type": "string" }, { - "description": "The payload of the webhook delivery", - "name": "payload", + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + { + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, { "description": "The ID of the Webhook delivery", "name": "id", "type": "string" }, { - "description": "The ID of the management server which executed delivery", - "name": "managementserverid", + "description": "The ID of the Webhook", + "name": "webhookid", "type": "string" }, { @@ -38048,18 +38897,18 @@ "type": "string" }, { - "description": "The type of the event", - "name": "eventtype", + "description": "The name of the management server which executed delivery", + "name": "managementservername", "type": "string" }, { - "description": "Whether Webhook delivery succeeded or not", - "name": "success", - "type": "boolean" + "description": "The end time of the Webhook delivery", + "name": "enddate", + "type": "date" }, { - "description": "The name of the management server which executed delivery", - "name": "managementservername", + "description": "The payload of the webhook delivery", + "name": "payload", "type": "string" } ], @@ -38080,11 +38929,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", @@ -38096,12 +38940,17 @@ "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" - }, - {} + } ] }, { @@ -38110,18 +38959,18 @@ "name": "listTungstenFabricProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -38142,19 +38991,13 @@ "related": "createTungstenFabricProvider", "response": [ { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { @@ -38162,46 +39005,52 @@ "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 name", - "name": "name", - "type": "string" - }, { "description": "true if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, + {}, { "description": "Tungsten-Fabric provider hostname", "name": "tungstenproviderhostname", "type": "string" }, + { + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Tungsten-Fabric provider uuid", "name": "tungstenprovideruuid", "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "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" } ] }, @@ -38234,18 +39083,18 @@ ], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "Deployment Planner name", "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -38268,28 +39117,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "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" - } + {} ] }, { @@ -38301,92 +39150,77 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, { "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "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", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "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 amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { "description": "comma-separated list of implicit host tags for the host", @@ -38394,33 +39228,33 @@ "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { @@ -38429,54 +39263,39 @@ "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { "description": "Host details in key/value pairs.", @@ -38484,36 +39303,41 @@ "type": "map" }, { - "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": "the CPU number of the host", + "name": "cpunumber", + "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", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -38527,56 +39351,45 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "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", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { "description": "the name of the host", @@ -38584,105 +39397,136 @@ "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, { "description": "the resource state of the host", "name": "resourcestate", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", "name": "hahost", "type": "boolean" }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, { "description": "the Zone name of the host", "name": "zonename", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, + {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { "description": "the date and time the host was removed", @@ -38690,13 +39534,18 @@ "type": "date" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" } ] @@ -38716,9 +39565,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" }, {}, { @@ -38726,17 +39575,17 @@ "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" + }, + {} ] }, { @@ -38759,18 +39608,18 @@ "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, {}, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -38778,22 +39627,6 @@ "isasync": true, "name": "updateAutoScaleVmGroup", "params": [ - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" - }, - { - "description": "list of scaleup autoscale policies", - "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" - }, { "description": "an optional field, whether to the display the group to the end user or not", "length": 255, @@ -38810,21 +39643,6 @@ "since": "4.4", "type": "string" }, - { - "description": "list of scaledown autoscale policies", - "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" - }, - { - "description": "the frequency in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" - }, { "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", "length": 255, @@ -38846,64 +39664,64 @@ "required": false, "since": "4.18.0", "type": "string" - } - ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" }, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "list" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "the frequency in which the performance counters to be collected", + "length": 255, + "name": "interval", + "required": false, + "type": "integer" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, "type": "list" - }, - {}, + } + ], + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "response": [ { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { @@ -38917,34 +39735,20 @@ "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": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the public port", + "name": "publicport", "type": "string" }, + {}, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", @@ -38952,19 +39756,13 @@ "type": "int" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { @@ -38973,8 +39771,28 @@ "type": "int" }, { - "description": "the autoscale vm group ID", - "name": "id", + "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", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the account owning the vm group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { @@ -38983,19 +39801,50 @@ "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "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", + "type": "string" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { "description": "the project id of the vm group", "name": "projectid", "type": "string" + }, + {}, + { + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" } ] }, @@ -39004,6 +39853,14 @@ "isasync": true, "name": "deleteSnapshot", "params": [ + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" + }, { "description": "The ID of the zone for the snapshot", "length": 255, @@ -39012,17 +39869,15 @@ "required": false, "since": "4.19.0", "type": "uuid" - }, - { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -39034,12 +39889,6 @@ "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", @@ -39053,95 +39902,97 @@ "name": "listVirtualMachines", "params": [ { - "description": "the ID of the virtual machine", + "description": "the host ID", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "description": "list vms by ssh keypair name", "length": 255, - "name": "showicon", + "name": "keypair", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the pod ID", "length": 255, - "name": "tags", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "haenable", + "name": "tags", "required": false, - "since": "4.15", - "type": "boolean" + "type": "map" }, { - "description": "list vms by ssh keypair name", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "keypair", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the security group ID", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "list vms by iso", + "description": "the group ID", "length": 255, - "name": "isoid", + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "list vms by template", + "description": "CPU arch of the VM", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.1", + "type": "string" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "details", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "list by network id", + "description": "list vms by template", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "state", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "keyword", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of AutoScaling VM Group", @@ -39153,66 +40004,63 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by network id", "length": 255, - "name": "displayvm", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "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": "the cluster ID", + "description": "list by the backup offering", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, - "since": "4.16.0", + "since": "4.17", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "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": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by iso", "length": 255, - "name": "forvirtualnetwork", + "name": "isoid", "required": false, - "type": "boolean" + "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.", @@ -39223,65 +40071,73 @@ "type": "boolean" }, { - "description": "list by the backup offering", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "backupofferingid", + "name": "showicon", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "displayvm", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "list vms by vpc", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the pod ID", + "description": "the availability zone ID", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the group ID", + "description": "the target hypervisor for the template", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "accumulate", "required": false, + "since": "4.17.0", "type": "boolean" }, { - "description": "the host ID", + "description": "list vms by vpc", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "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 only resources belonging to the domain specified", @@ -39292,40 +40148,44 @@ "type": "uuid" }, { - "description": "the availability zone ID", + "description": "the cluster ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, + "since": "4.16.0", "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the instances by userdata", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "userdataid", + "related": "", "required": false, + "since": "4.20.1", "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list by the service offering", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "hypervisor", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "the ID of the virtual machine", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, @@ -39339,263 +40199,173 @@ "type": "list" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "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": "userdata", + "name": "state", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "string" }, { - "description": "list vms by affinity group", + "description": "the security group ID", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, + "since": "4.15", "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": "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": "accumulate", + "name": "details", "required": false, - "since": "4.17.0", + "type": "list" + }, + { + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "length": 255, + "name": "userdata", + "required": false, + "since": "4.18.0.0", "type": "boolean" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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 date when this virtual machine was created", - "name": "created", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", "type": "date" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 ip address of the nic", - "name": "ipaddress", - "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 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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the 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": "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - } - ], - "type": "set" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, + {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -39604,29 +40374,35 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "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": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "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", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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.", @@ -39634,84 +40410,103 @@ "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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 disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, - {}, { - "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": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { @@ -39720,22 +40515,27 @@ "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -39744,183 +40544,392 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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": "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": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the name of the security group", + "description": "the name of the affinity group", "name": "name", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account owning the security group", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "path of the Domain the security group belongs to", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "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": "security group name", - "name": "securitygroupname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the account associated with the tag", + "name": "account", "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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": "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 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -39928,55 +40937,60 @@ "name": "domainid", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project id of the group", + "name": "projectid", + "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 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", @@ -39984,8 +40998,8 @@ "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" }, { @@ -39993,18 +41007,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -40018,8 +41027,13 @@ "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", "type": "string" }, { @@ -40028,31 +41042,31 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -40061,13 +41075,13 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "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" }, { @@ -40076,385 +41090,243 @@ "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "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 domain associated with the tag", - "name": "domain", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the 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 traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, { - "description": "the 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "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 state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" } ] }, @@ -40463,6 +41335,14 @@ "isasync": false, "name": "listDiskOfferings", "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": "the storage type of the service offering. Values are local and shared.", "length": 255, @@ -40472,26 +41352,28 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "ID of the disk offering", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -40501,14 +41383,20 @@ "type": "boolean" }, { - "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.20.0", "type": "uuid" }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, @@ -40519,56 +41407,41 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "listed offerings support disk encryption", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "encrypt", "required": false, - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, "name": "volumeid", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "since": "4.17", "type": "uuid" }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", - "length": 255, - "name": "state", - "required": false, - "since": "4.19", - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -40580,44 +41453,48 @@ "type": "string" }, { - "description": "ID of the disk offering", + "description": "", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "id of zone disk offering is associated with", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.13", + "since": "4.20.0", "type": "uuid" } ], "related": "createDiskOffering", "response": [ { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "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": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { "description": "burst io requests read rate of the disk offering", @@ -40630,18 +41507,13 @@ "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -40650,9 +41522,9 @@ "type": "long" }, { - "description": "state of the disk offering", - "name": "state", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { "description": "length (in seconds) of the burst", @@ -40660,29 +41532,34 @@ "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { "description": "bytes read rate of the disk offering", @@ -40690,19 +41567,20 @@ "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "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 storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { "description": "whether to display the offering to the end user or not.", @@ -40710,80 +41588,74 @@ "type": "boolean" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, - {}, { - "description": "the name of the disk offering", - "name": "name", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "the tags for the disk 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 max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, + {}, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "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": "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": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -40792,14 +41664,14 @@ "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" } ] }, @@ -40818,13 +41690,18 @@ } ], "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", @@ -40834,11 +41711,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" } ] }, @@ -40848,53 +41720,69 @@ "name": "upgradeKubernetesCluster", "params": [ { - "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" }, { - "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,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ + { + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, { "description": "path of the domain to which the Kubernetes cluster belongs", "name": "domainpath", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { "description": "the id of the Kubernetes cluster", @@ -40902,8 +41790,18 @@ "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { @@ -40917,90 +41815,75 @@ "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "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": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "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 name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 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 project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "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 type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { "description": "the account associated with the Kubernetes cluster", @@ -41008,34 +41891,23 @@ "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" - }, - { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "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", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, - {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { @@ -41044,19 +41916,19 @@ "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 state of the Kubernetes cluster", - "name": "state", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" } ] }, @@ -41066,72 +41938,79 @@ "name": "createCondition", "params": [ { - "description": "ID of the Counter.", + "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", "required": true, - "type": "uuid" + "type": "long" }, { - "description": "the domain ID of the account.", + "description": "an optional project for condition", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "description": "ID of the Counter.", "length": 255, - "name": "relationaloperator", + "name": "counterid", + "related": "createCounter,listCounters", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, - "name": "account", - "required": false, + "name": "relationaloperator", + "required": true, "type": "string" }, { - "description": "an optional project for condition", + "description": "the domain ID of the account.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "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" } ], "related": "listConditions", "response": [ { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "the project name of the Condition", + "name": "project", + "type": "string" }, + {}, { - "description": "the owner of the Condition.", - "name": "account", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "the owner of the Condition.", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -41139,57 +42018,50 @@ "type": "integer" }, { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" - }, - {} + } ] }, { @@ -41205,126 +42077,146 @@ "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": "", + "description": "List projects by username", "length": 255, - "name": "pagesize", + "name": "username", "required": false, - "type": "integer" + "type": "string" }, { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "list" + "type": "map" }, { - "description": "List projects by username", + "description": "", "length": 255, - "name": "username", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list projects by state", + "description": "list projects by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list projects by name", + "description": "list projects by state", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "list projects by project ID", + "description": "list projects by display text", "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the resource icon for projects", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "showicon", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list projects by display text", + "description": "", "length": 255, - "name": "displaytext", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "keyword", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "List projects by tags (key/value pairs)", + "description": "list projects by project ID", "length": 255, - "name": "tags", + "name": "id", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" } ], "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { @@ -41333,13 +42225,28 @@ "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { @@ -41348,67 +42255,62 @@ "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "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 total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project 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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -41417,91 +42319,98 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "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 project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "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 state of the project", - "name": "state", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "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", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, + {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", "type": "list" }, { @@ -41510,19 +42419,9 @@ "type": "long" }, { - "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 memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { "description": "the total memory (in MB) available to be created for this project", @@ -41530,51 +42429,50 @@ "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "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 number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, - {}, { "description": "the domain name where the project belongs to", "name": "domain", @@ -41584,33 +42482,7 @@ "description": "the total volume available for this project", "name": "volumeavailable", "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -41620,47 +42492,54 @@ "name": "createAccount", "params": [ { - "description": "Unique username.", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "username", - "required": true, + "name": "accountid", + "required": false, "type": "string" }, { - "description": "firstname", + "description": "email", "length": 255, - "name": "firstname", + "name": "email", "required": true, "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.", + "description": "Creates the account under the specified role.", "length": 255, - "name": "account", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "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 See Docs section.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "accounttype", + "required": false, + "type": "integer" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "accountid", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "accountdetails", "required": false, - "type": "uuid" + "type": "map" + }, + { + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, + "type": "string" }, { "description": "lastname", @@ -41670,76 +42549,184 @@ "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": "User UUID, required for adding account from external provisioning system", + "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": "userid", + "name": "account", "required": false, "type": "string" }, { - "description": "details for account used to store specific parameters", + "description": "Network domain for the account's networks", "length": 255, - "name": "accountdetails", + "name": "networkdomain", "required": false, - "type": "map" - }, - { - "description": "email", - "length": 255, - "name": "email", - "required": true, "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "firstname", "length": 255, - "name": "networkdomain", - "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": "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": "timezone", - "required": false, + "name": "password", + "required": true, "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,moveDomain", "required": false, "type": "uuid" } ], "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "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", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, { "description": "the id of the account", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "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", + "type": "string" + }, { "description": "the total number of cpu cores owned by account", "name": "cputotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { @@ -41748,62 +42735,127 @@ "type": "resourceiconresponse" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, - {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of 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", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "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 list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + {}, { "description": "the total number of public ip addresses available for this account to acquire", "name": "ipavailable", "type": "string" }, - {}, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "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 cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "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", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, + {}, { "description": "the name of the role", "name": "rolename", @@ -41814,24 +42866,34 @@ "name": "user", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "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", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user state", + "name": "state", + "type": "string" }, { "description": "the name of the role", @@ -41839,53 +42901,48 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the role", - "name": "roleid", + "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 domain ID of the user", - "name": "domainid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -41894,19 +42951,19 @@ "type": "integer" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the api key of the user", @@ -41914,41 +42971,36 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "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 type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the state of the account", - "name": "state", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { @@ -41957,204 +43009,34 @@ "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "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) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", "type": "list" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total number of 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 secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "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 account", - "name": "vpctotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, { "description": "the total number of templates available to be created by this account", "name": "templateavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "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 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 public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -42175,251 +43057,131 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the password (if exists) of the virtual machine", "name": "password", "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { "description": "the amount of the vm's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the 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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "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": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "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": "tag key name", - "name": "key", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 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 project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -42428,89 +43190,93 @@ "type": "resourceiconresponse" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "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" }, { @@ -42522,73 +43288,110 @@ "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 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 name of the group", + "name": "project", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -42601,8 +43404,13 @@ "name": "tags", "response": [ { - "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" }, { @@ -42611,18 +43419,18 @@ "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -42631,510 +43439,325 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "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" } ], "type": "set" }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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 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", + "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 domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "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" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" - }, - { - "description": "the 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": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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 key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "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 name of the affinity group", - "name": "project", - "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": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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": "publicip", "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "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 vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -43143,28 +43766,53 @@ "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 IPv6 address of network", - "name": "ip6address", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -43173,18 +43821,18 @@ "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": "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -43193,19 +43841,19 @@ "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -43218,48 +43866,287 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "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", + "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", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + {}, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "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": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], @@ -43283,28 +44170,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "4.4.0" }, @@ -43313,13 +44200,6 @@ "isasync": true, "name": "createTungstenFabricServiceGroup", "params": [ - { - "description": "Tungsten-Fabric service group start port", - "length": 255, - "name": "startport", - "required": true, - "type": "integer" - }, { "description": "Tungsten-Fabric service group protocol", "length": 255, @@ -43328,11 +44208,11 @@ "type": "string" }, { - "description": "Tungsten-Fabric service group name", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "name", + "name": "startport", "required": true, - "type": "string" + "type": "integer" }, { "description": "the ID of zone", @@ -43348,40 +44228,48 @@ "name": "endport", "required": true, "type": "integer" + }, + { + "description": "Tungsten-Fabric service group name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { "description": "Tungsten-Fabric service group uuid", "name": "uuid", "type": "string" }, + {}, { "description": "Tungsten-Fabric service group protocol", "name": "protocol", "type": "string" }, { - "description": "Tungsten-Fabric service group name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "Tungsten-Fabric service group start port", @@ -43389,14 +44277,13 @@ "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" } ] @@ -43421,12 +44308,6 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -43437,6 +44318,12 @@ "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" @@ -43447,83 +44334,89 @@ "name": "registerIso", "params": [ { - "description": "the ID of the zone you wish to register the ISO to.", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "isdynamicallyscalable", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "the name of the ISO", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "Register ISO for the project", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "the name of the ISO", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "Image store UUID", "length": 255, - "name": "account", + "name": "imagestoreuuid", "required": false, "type": "string" }, { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "true if you want this ISO to be featured", + "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": "isfeatured", + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "passwordenabled", + "name": "bootable", "required": false, "type": "boolean" }, @@ -43536,44 +44429,38 @@ "type": "string" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", + "description": "an optional account name. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "bootable", + "name": "isextractable", "required": false, "type": "boolean" }, { - "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 ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "Register ISO for the project", "length": 255, - "name": "directdownload", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "ispublic", + "name": "passwordenabled", "required": false, "type": "boolean" } @@ -43581,89 +44468,106 @@ "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "checksum of the template", - "name": "checksum", + "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": "the date this template was removed", - "name": "removed", + "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": "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 format of the template.", + "name": "format", + "type": "imageformat" }, { - "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 status of the template", - "name": "status", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the name of the zone for this template", + "name": "zonename", + "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 template ID", + "name": "id", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + {}, { - "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 URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "path of the Domain associated with the tag", "name": "domainpath", @@ -43680,13 +44584,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -43699,19 +44603,14 @@ "name": "value", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -43723,44 +44622,28 @@ "type": "set" }, { - "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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "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": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, - {}, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { @@ -43769,115 +44652,104 @@ "type": "string" }, { - "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": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project name of the template", + "name": "project", "type": "string" }, - {}, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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 type of the template", - "name": "templatetype", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "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": "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 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": "the ID of the domain to which the template belongs", - "name": "domainid", + "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": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "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": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, { "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "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 template name", - "name": "name", - "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the processor bit size", @@ -43885,13 +44757,28 @@ "type": "int" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -43900,24 +44787,24 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" } ] }, @@ -43934,20 +44821,19 @@ "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": "", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -43957,11 +44843,12 @@ "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", @@ -43973,7 +44860,6 @@ ], "related": "addCiscoAsa1000vResource", "response": [ - {}, {}, {}, { @@ -43983,6 +44869,7 @@ }, {}, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -44008,27 +44895,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -44036,6 +44923,14 @@ "isasync": false, "name": "upgradeRouterTemplate", "params": [ + { + "description": "upgrades all routers within the specified cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "upgrades all routers owned by the specified account", "length": 255, @@ -44044,10 +44939,10 @@ "type": "string" }, { - "description": "upgrades all routers within the specified zone", + "description": "upgrades all routers within the specified pod", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -44068,18 +44963,10 @@ "type": "uuid" }, { - "description": "upgrades all routers within the specified cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "upgrades all routers within the specified pod", + "description": "upgrades all routers within the specified zone", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } @@ -44091,195 +44978,144 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, {} ] }, { - "description": "Lists IPv4 subnets for guest networks.", - "isasync": false, - "name": "listIpv4SubnetsForGuestNetwork", + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", "params": [ { - "description": "UUID of the IPv4 subnet for guest network.", + "description": "the host ID", "length": 255, "name": "id", - "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", - "required": false, + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" - }, + } + ], + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "response": [ { - "description": "The CIDR of the Ipv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "UUID of network to which the IPv4 subnet is associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of VPC to which the IPv4 subnet is associated to.", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "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": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "createIpv4SubnetForGuestNetwork", - "response": [ - { - "description": "date when this IPv4 subnet was created.", + "description": "the date and time the host 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", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "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": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - {}, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, - {}, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Cancels host maintenance.", - "isasync": true, - "name": "cancelHostMaintenance", - "params": [ + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "response": [ + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "events available for the host", + "name": "events", "type": "string" }, { @@ -44287,85 +45123,71 @@ "name": "ipaddress", "type": "string" }, - {}, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "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 MHz", - "name": "cpuallocatedvalue", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "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": "the Pod name of the host", - "name": "podname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -44374,33 +45196,23 @@ "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "events available for the host", - "name": "events", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { @@ -44408,180 +45220,114 @@ "name": "hypervisorversion", "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": "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 amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, { "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "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": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the 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": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the 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 OS category ID of the host", - "name": "oscategoryid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, { "description": "true if the host is disconnected. False otherwise.", "name": "disconnected", "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "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 Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, { "description": "Maximum displays per user", "name": "maxheads", @@ -44592,11 +45338,6 @@ "name": "maxresolutionx", "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", @@ -44607,66 +45348,51 @@ "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": "Video RAM for this vGPU type", "name": "videoram", "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" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the 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 the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", "name": "memorywithoverprovisioning", "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" } ] }, @@ -44675,14 +45401,6 @@ "isasync": false, "name": "listVlanIpRanges", "params": [ - { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "the Pod ID of the VLAN IP range", "length": 255, @@ -44691,14 +45409,6 @@ "required": false, "type": "uuid" }, - { - "description": "network id of the VLAN IP range", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "project who will own the VLAN", "length": 255, @@ -44708,11 +45418,11 @@ "type": "uuid" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -44722,18 +45432,19 @@ "type": "string" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "", "length": 255, - "name": "vlan", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", "length": 255, - "name": "forvirtualnetwork", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the VLAN IP range", @@ -44744,148 +45455,162 @@ "type": "uuid" }, { - "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "physical network id of the VLAN IP range", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "physical network id of the VLAN IP range", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "network id of the VLAN IP range", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "pagesize", + "name": "forvirtualnetwork", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "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 project id of the vlan range", - "name": "projectid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" + "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 VLAN IP range belongs", - "name": "domainpath", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 domain ID of the VLAN IP range", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { @@ -44894,29 +45619,30 @@ "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" } ] }, @@ -44926,11 +45652,11 @@ "name": "updateZone", "params": [ { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "sort key of the zone, integer", "length": 255, - "name": "ispublic", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the guest CIDR address for the Zone", @@ -44940,18 +45666,19 @@ "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the ID of the Zone", "length": 255, - "name": "dns1", - "required": false, - "type": "string" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the dns search order list", + "description": "the second DNS for the Zone", "length": 255, - "name": "dnssearchorder", + "name": "dns2", "required": false, - "type": "list" + "type": "string" }, { "description": "the first internal DNS for the Zone", @@ -44961,18 +45688,18 @@ "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the first DNS for the Zone", "length": 255, - "name": "allocationstate", + "name": "dns1", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "ip6dns2", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the second internal DNS for the Zone", @@ -44982,54 +45709,53 @@ "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "dns2", + "name": "name", "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "domain", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "sort key of the zone, integer", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "sortkey", + "name": "domain", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the Zone", + "description": "the details for the Zone", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the ID of the Zone", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "dhcpprovider", + "required": false, + "type": "string" }, { - "description": "the dhcp Provider for the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "dhcpprovider", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "details", + "name": "ip6dns1", "required": false, - "type": "map" + "type": "string" }, { "description": "true if local storage offering enabled, false otherwise", @@ -45039,35 +45765,29 @@ "type": "boolean" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the dns search order list", "length": 255, - "name": "ip6dns1", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" } ], "related": "createZone,listZones,listZones", "response": [ { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, - {}, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Zone name", @@ -45075,62 +45795,42 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the network type of the zone; can be Basic or Advanced", "name": "networktype", "type": "string" }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -45139,153 +45839,103 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod ID", + "name": "podid", "type": "string" } ], "type": "list" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "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": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "Zone id", + "name": "id", + "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { @@ -45294,54 +45944,135 @@ "type": "resourceiconresponse" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "AS Number Range", + "name": "asnrange", "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": "Network domain name for the networks in the zone", - "name": "domain", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the second internal DNS for the Zone", "name": "internaldns2", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" } ] @@ -45359,18 +46090,11 @@ "required": true, "type": "uuid" }, - { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, { "description": "the ID of the volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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" }, @@ -45380,38 +46104,35 @@ "name": "mode", "required": true, "type": "string" + }, + { + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" } ], - "related": "downloadImageStoreObject,extractIso,extractSnapshot,extractTemplate", + "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", "response": [ { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, { "description": "the mode of extraction - upload or download", "name": "extractMode", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -45425,19 +46146,9 @@ "type": "string" }, { - "description": "the id of extracted object", - "name": "id", - "type": "string" - }, - { - "description": "", - "name": "resultstring", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { "description": "the state of the extracted object", @@ -45452,66 +46163,152 @@ "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 status of the extraction", + "name": "status", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { "description": "zone ID the object was extracted from", "name": "zoneid", "type": "string" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + { + "description": "", + "name": "resultstring", + "type": "string" + }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "the id of extracted object", + "name": "id", + "type": "string" } ] }, { - "description": "Releases an existing dedicated IPv4 subnet for a zone.", - "isasync": true, - "name": "releaseIpv4SubnetForZone", + "description": "Lists IPv4 subnets for guest networks.", + "isasync": false, + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "Id of the guest network IPv4 subnet", + "description": "UUID of the IPv4 subnet for guest network.", "length": 255, "name": "id", + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "The CIDR of the Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" + }, + { + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of VPC to which the IPv4 subnet is associated to.", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of network to which the IPv4 subnet is associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": true, + "required": false, "type": "uuid" } ], - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "related": "createIpv4SubnetForGuestNetwork", "response": [ + { + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" + }, { "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, + {}, { - "description": "guest IPv4 subnet", + "description": "subnet of the IPv4 network", "name": "subnet", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { @@ -45520,31 +46317,45 @@ "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, + { + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" + }, {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "id of the guest IPv4 subnet", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the IPv4 subnet for guest network", "name": "id", "type": "string" }, { - "description": "name 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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" } ], "since": "4.20.0" @@ -45554,13 +46365,6 @@ "isasync": false, "name": "listProjectAccounts", "params": [ - { - "description": "list accounts of the project by account name", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "list invitation by user ID", "length": 255, @@ -45570,111 +46374,107 @@ "type": "uuid" }, { - "description": "list accounts of the project by project role id", + "description": "", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "ID of the project", + "description": "list accounts of the project by role", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": true, + "name": "role", + "required": false, + "type": "string" + }, + { + "description": "list accounts of the project by project role id", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list accounts of the project by account name", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list accounts of the project by role", + "description": "ID of the project", "length": 255, - "name": "role", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "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 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 project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -45683,38 +46483,33 @@ "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "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 public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { @@ -45723,123 +46518,148 @@ "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total 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 number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the account name of the project's owners", + "name": "owner", "type": "list" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, + {}, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, - {}, { "description": "the total number of snapshots which can be stored by this project", "name": "snapshotlimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the name of the project", - "name": "name", + "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 owned by project", - "name": "networktotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -45848,13 +46668,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -45867,292 +46687,253 @@ "name": "projectid", "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" } ], "type": "list" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, + {}, { - "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" } ], "since": "3.0.0" }, { - "description": "Updates an existing autoscale policy.", + "description": "Releases an existing dedicated IPv4 subnet for a zone.", "isasync": true, - "name": "updateAutoScalePolicy", + "name": "releaseIpv4SubnetForZone", "params": [ { - "description": "the ID of the autoscale policy", + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": true, "type": "uuid" - }, - { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", - "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" - }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "listConditions", - "required": false, - "type": "list" - }, - { - "description": "the duration in which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" - }, - { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" } ], - "related": "listAutoScalePolicies", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ - {}, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the autoscale policy ID", - "name": "id", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, + {}, + {}, { - "description": "the domain ID of the autoscale policy", + "description": "the domain ID of the IPv4 subnet", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the account of the IPv4 subnet", + "name": "account", + "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": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" - }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" } - ] + ], + "since": "4.20.0" }, { - "description": "Creates a IPv4 subnet for a zone.", + "description": "Updates an existing autoscale policy.", "isasync": true, - "name": "createIpv4SubnetForZone", + "name": "updateAutoScalePolicy", "params": [ { - "description": "domain ID of the account owning the IPv4 subnet", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "conditionids", + "related": "listConditions", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "project who will own the IPv4 subnet", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", + "name": "duration", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The CIDR of the IPv4 subnet.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "subnet", + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "account who will own the IPv4 subnet", + "description": "the name of the autoscale policy", "length": 255, - "name": "account", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "UUID of the zone which the IPv4 subnet belongs to.", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "quiettime", + "required": false, + "type": "integer" } ], - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "related": "listAutoScalePolicies", "response": [ { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" }, {}, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" } - ], - "since": "4.20.0" + ] }, { "description": "Creates a disk offering.", @@ -46160,42 +46941,40 @@ "name": "createDiskOffering", "params": [ { - "description": "name of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "displayoffering", + "required": false, + "type": "boolean" }, { - "description": "burst requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemax", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "iopswriteratemax", "required": false, - "since": "4.13", - "type": "list" + "type": "long" }, { - "description": "whether disk offering iops is custom or not", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "customizediops", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "list" }, { - "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": "Volumes using this offering should be encrypted", @@ -46206,96 +46985,74 @@ "type": "boolean" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", - "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", - "required": false, - "since": "4.15", - "type": "uuid" - }, - { - "description": "length (in seconds) of the burst", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "bytesreadratemaxlength", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "min iops of the disk offering", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "miniops", + "name": "storagetype", "required": false, - "type": "long" + "type": "string" }, { - "description": "whether disk offering size is custom or not", + "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": "customized", + "name": "disksizestrictness", "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "min iops of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "miniops", "required": false, "type": "long" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "io requests read rate of the disk offering", + "description": "details to specify disk offering parameters", "length": 255, - "name": "iopsreadrate", + "name": "details", "required": false, - "type": "long" + "since": "4.16", + "type": "map" }, { - "description": "burst bytes write rate of the disk offering", + "description": "name of the disk offering", "length": 255, - "name": "byteswriteratemax", - "required": false, - "type": "long" + "name": "name", + "required": true, + "type": "string" }, { - "description": "bytes write rate of the disk offering", + "description": "max iops of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "list" - }, - { - "description": "io requests write rate of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "iopsreadrate", "required": false, "type": "long" }, @@ -46306,13 +47063,6 @@ "required": false, "type": "long" }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "length": 255, - "name": "hypervisorsnapshotreserve", - "required": false, - "type": "integer" - }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, @@ -46322,11 +47072,13 @@ "type": "string" }, { - "description": "max iops of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "maxiops", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { "description": "An alternate display text of the disk offering, defaults to 'name'.", @@ -46336,91 +47088,121 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "bytesreadratemax", "required": false, "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "bytesreadrate", + "name": "byteswriterate", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopswriterate", "required": false, "type": "long" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "storagetype", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "list" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "provisioningtype", + "name": "customized", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "displayoffering", + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "whether disk offering iops is custom or not", + "length": 255, + "name": "customizediops", "required": false, "type": "boolean" }, { - "description": "details to specify disk offering parameters", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "length (in seconds) of the burst", "length": 255, - "name": "details", + "name": "iopswriteratemaxlength", "required": false, - "since": "4.16", - "type": "map" + "type": "long" + }, + { + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" } ], "related": "", "response": [ { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, + {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "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", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { @@ -46429,101 +47211,140 @@ "type": "long" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the date this disk offering was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "unique ID of the disk offering", + "name": "id", + "type": "string" }, { "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, - {}, + { + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "name": "cacheMode", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering", + "name": "name", "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", "type": "string" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "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": "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": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "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(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" + }, + { + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" + }, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -46531,66 +47352,137 @@ "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + } + ] + }, + { + "description": "Creates a IPv4 subnet for a zone.", + "isasync": true, + "name": "createIpv4SubnetForZone", + "params": [ + { + "description": "The CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "project who will own the IPv4 subnet", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "domain ID of the account owning the IPv4 subnet", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "UUID of the zone which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "state of the disk offering", - "name": "state", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, + {}, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, + {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Lists details of network protocols", @@ -46607,19 +47499,20 @@ ], "related": "", "response": [ + {}, { - "description": "the details of the protocol parameter", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the description of the protocol parameter", - "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 protocol parameter", - "name": "name", + "description": "the description of the protocol parameter", + "name": "description", "type": "string" }, { @@ -46629,16 +47522,15 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the protocol parameter", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" + } ], "since": "4.19.0" }, @@ -46648,17 +47540,24 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "the ID of the load balancer rule", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -46672,34 +47571,53 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the load balancer rule", "length": 255, - "name": "keyword", + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "createLBHealthCheckPolicy", "response": [ + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -46712,18 +47630,18 @@ "type": "string" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { @@ -46732,57 +47650,31 @@ "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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" } ], "type": "list" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" } ], @@ -46793,6 +47685,14 @@ "isasync": true, "name": "migrateVirtualMachineWithVolume", "params": [ + { + "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" + }, { "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, @@ -46804,18 +47704,10 @@ "description": "Destination Host ID to migrate VM to.", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, - { - "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" - }, { "description": "the ID of the virtual machine", "length": 255, @@ -46828,419 +47720,101 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "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", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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 gateway of the nic", - "name": "gateway", - "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": "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": "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": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project name where tag belongs to", + "name": "project", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" } ], "type": "set" }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - {}, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, {}, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the vm", - "name": "project", + "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -47249,8 +47823,8 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -47258,99 +47832,47 @@ "name": "cpuspeed", "type": "integer" }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "security group name", + "name": "securitygroupname", "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", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "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 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 starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -47358,38 +47880,33 @@ "name": "endport", "type": "integer" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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" }, { @@ -47402,19 +47919,14 @@ "name": "customer", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -47423,102 +47935,224 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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 resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "account owning the security group rule", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], "type": "set" }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "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 project id of the group", "name": "projectid", "type": "string" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the 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": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -47530,8 +48164,8 @@ "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -47540,178 +48174,70 @@ "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 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 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" } ], "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" } ], "type": "set" }, { - "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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the 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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the total number of network traffic bytes received", @@ -47719,34 +48245,45 @@ "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the disk 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 project id of the vm", + "name": "projectid", "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", @@ -47754,53 +48291,73 @@ "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -47809,93 +48366,368 @@ "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the 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": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "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": "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" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 group ID of the virtual machine", - "name": "groupid", + "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", + "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", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the 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 virtual machine", - "name": "id", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 availability zone for the virtual machine", - "name": "zonename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 ID of the corresponding network", + "name": "networkid", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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": "the ip address of the nic", + "name": "ipaddress", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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 gateway of the nic", + "name": "gateway", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -47904,8 +48736,33 @@ "type": "date" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -47913,10 +48770,50 @@ "name": "diskkbsread", "type": "long" }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, { "description": "the memory used by the VM in KiB", "name": "memorykbs", "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" } ] }, @@ -47926,59 +48823,60 @@ "name": "updateUser", "params": [ { - "description": "last name", + "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": "lastname", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "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": "timezone", + "name": "mandate2fa", "required": false, - "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": "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": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "mandate2fa", + "name": "currentpassword", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "string" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "first name", "length": 255, - "name": "password", + "name": "firstname", "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": "last name", "length": 255, - "name": "currentpassword", + "name": "lastname", "required": false, "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "userapikey", + "name": "timezone", "required": false, "type": "string" }, { - "description": "email", + "description": "Unique username", "length": 255, - "name": "email", + "name": "username", "required": false, "type": "string" }, @@ -47991,9 +48889,9 @@ "type": "uuid" }, { - "description": "Unique username", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "username", + "name": "userapikey", "required": false, "type": "string" }, @@ -48003,54 +48901,56 @@ "name": "usersecretkey", "required": false, "type": "string" + }, + { + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "length": 255, + "name": "password", + "required": false, + "type": "string" } ], "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the user email address", + "name": "email", "type": "string" }, + {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user ID", + "name": "id", "type": "string" }, - {}, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -48059,18 +48959,23 @@ "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 name of the role", - "name": "rolename", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -48079,23 +48984,24 @@ "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 user lastname", - "name": "lastname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user name", - "name": "username", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -48104,40 +49010,44 @@ "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, - {}, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ] }, @@ -48150,34 +49060,34 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "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 current status of the latest async job 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" + } ] }, { @@ -48193,25 +49103,33 @@ "type": "string" }, { - "description": "the cluster ID for the host", + "description": "the Pod ID for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "the Zone ID for the host", "length": 255, - "name": "password", + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the cluster name for the host", + "length": 255, + "name": "clustername", "required": false, "type": "string" }, { - "description": "hypervisor type of the host", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "hypervisor", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { @@ -48222,128 +49140,55 @@ "type": "list" }, { - "description": "the Zone ID for the host", + "description": "hypervisor type of the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "hypervisor", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the cluster name for the host", + "description": "the cluster ID for the host", "length": 255, - "name": "clustername", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "username", "required": false, "type": "string" } ], - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "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 host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the host version", - "name": "version", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { @@ -48352,34 +49197,14 @@ "type": "double" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "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 hypervisor version", @@ -48387,13 +49212,13 @@ "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { @@ -48401,89 +49226,24 @@ "name": "cpuspeed", "type": "long" }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, { "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", "name": "memorywithoverprovisioning", "type": "string" }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, { "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", @@ -48495,87 +49255,86 @@ "type": "string" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, - {}, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the 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": "the last annotation set on this host by an admin", @@ -48583,38 +49342,13 @@ "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { @@ -48623,321 +49357,326 @@ "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the Pod ID of the host", + "name": "podid", "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": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - } - ] - }, - { - "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": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "The ID of 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 amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ - { - "description": "name of the availability zone", - "name": "zonename", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "pod name of the volume", + "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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, + {}, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" + } + ] + }, + { + "description": "Attaches a disk volume to a virtual machine.", + "isasync": true, + "name": "attachVolume", + "params": [ + { + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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 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": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "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 status of the volume", + "name": "status", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -48946,8 +49685,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -48956,8 +49695,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -48966,62 +49705,68 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "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" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, + {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { "description": "ID of the service offering for root disk", @@ -49029,293 +49774,316 @@ "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the path of the volume", + "name": "path", "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": "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 read (IO) of disk on the vm", - "name": "diskioread", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, - {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - } - ] - }, - { - "description": "Updates a project", - "isasync": true, - "name": "updateProject", - "params": [ - { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", - "length": 255, - "name": "swapowner", - "required": false, + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "ID of the user to be promoted/demoted", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": false, - "type": "uuid" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the project", - "length": 255, - "name": "name", - "required": false, - "since": "4.19.0", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "display text of the project", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "new Admin account for the project", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" - } - ], - "related": "activateProject,createProject,suspendProject", - "response": [ - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" }, { - "description": "the id of the project", - "name": "id", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the date this project was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, + {}, { - "description": "the name of the project", - "name": "name", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, - {}, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" + } + ] + }, + { + "description": "Updates a project", + "isasync": true, + "name": "updateProject", + "params": [ + { + "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "length": 255, + "name": "swapowner", + "required": false, + "type": "boolean" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "name of the project", + "length": 255, + "name": "name", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "Account level role to be assigned to the user/account : Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "display text of the project", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "ID of the user to be promoted/demoted", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "id of the project to be modified", + "length": 255, + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "description": "new Admin account for the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "activateProject,createProject,suspendProject", + "response": [ + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { @@ -49324,28 +50092,33 @@ "type": "long" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "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", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { @@ -49353,39 +50126,75 @@ "name": "vpctotal", "type": "long" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, { "description": "the total primary storage space (in GiB) available to be used for this project", "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, + {}, { "description": "the displaytext of the project", "name": "displaytext", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "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 project", - "name": "secondarystorageavailable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { @@ -49393,28 +50202,28 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -49423,57 +50232,158 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "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" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, { "description": "the total secondary storage space (in GiB) the project can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + {}, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "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", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "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 virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" } ], "since": "3.0.0" @@ -49484,38 +50394,40 @@ "name": "listLoadBalancers", "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": "the name of the load balancer", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "scheme", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the network ID of the source IP address", + "description": "the ID of the load balancer", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, @@ -49535,39 +50447,32 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the source IP address of the load balancer", + "description": "the name of the load balancer", "length": 255, - "name": "sourceipaddress", + "name": "name", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "account", + "name": "scheme", "required": false, "type": "string" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the source IP address of the load balancer", "length": 255, - "name": "isrecursive", + "name": "sourceipaddress", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -49578,100 +50483,47 @@ "type": "uuid" }, { - "description": "the ID of the load balancer", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "createLoadBalancer", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the Load Balancer", "name": "account", + "required": false, "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "Load Balancer source ip network id", + "description": "the network ID of the source IP address", + "length": 255, "name": "sourceipaddressnetworkid", - "type": "string" - }, + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + } + ], + "related": "createLoadBalancer", + "response": [ { "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 name of the Load Balancer", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - } - ], - "type": "list" - }, { "description": "Load Balancer source ip", "name": "sourceipaddress", @@ -49679,59 +50531,47 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "the state of the instance", - "name": "state", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "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 resource tags associated with the Load Balancer", - "name": "tags", - "response": [ + }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -49740,33 +50580,77 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" + } + ], + "type": "list" + }, + { + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the instance", + "name": "name", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", "type": "string" } ], @@ -49777,24 +50661,50 @@ "name": "id", "type": "string" }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, { "description": "the domain of the Load Balancer", "name": "domain", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" } ], @@ -49816,12 +50726,22 @@ ], "related": "getUserKeys", "response": [ + {}, + { + "description": "whether api key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the secret key of the registered user", "name": "secretkey", "type": "string" }, - {}, { "description": "the api key of the registered user", "name": "apikey", @@ -49832,11 +50752,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ] }, @@ -49856,27 +50771,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 UUID of the latest async job acting on 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" }, @@ -49886,27 +50801,27 @@ "name": "listVpnConnections", "params": [ { - "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": "list only resources belonging to the domain specified", + "description": "id of vpc", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "", @@ -49916,33 +50831,33 @@ "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": "id of the vpn connection", "length": 255, - "name": "listall", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "type": "boolean" + "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": "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": "id of the vpn connection", + "description": "", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -49953,17 +50868,17 @@ "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": "id of vpc", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" } @@ -49971,39 +50886,19 @@ "related": "createVpnConnection,updateVpnConnection", "response": [ { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "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 owner", - "name": "domainid", - "type": "string" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" - }, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "if DPD is enabled for customer gateway", @@ -50016,34 +50911,50 @@ "type": "string" }, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "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", @@ -50051,67 +50962,71 @@ "type": "string" }, { - "description": "the connection ID", - "name": "id", + "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 vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "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 project id", + "name": "projectid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "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": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, - {} + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + } ] }, { @@ -50120,12 +51035,11 @@ "name": "removeTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "networkuuid", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the uuid of Tungsten-Fabric policy", @@ -50135,19 +51049,20 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "the ID of zone", "length": 255, - "name": "networkuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, {}, { @@ -50156,20 +51071,9 @@ "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 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", @@ -50181,7 +51085,18 @@ "name": "network", "type": "list" }, - {} + {}, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -50190,10 +51105,10 @@ "name": "updateCloudToUseObjectStore", "params": [ { - "description": "the image store provider name", + "description": "the name for the image store", "length": 255, - "name": "provider", - "required": true, + "name": "name", + "required": false, "type": "string" }, { @@ -50211,33 +51126,23 @@ "type": "string" }, { - "description": "the name for the image store", + "description": "the image store provider name", "length": 255, - "name": "name", - "required": false, + "name": "provider", + "required": true, "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "response": [ { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -50256,41 +51161,51 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 name of the image store", - "name": "name", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, {}, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" } ], "since": "4.3.0" @@ -50301,12 +51216,11 @@ "name": "createASNRange", "params": [ { - "description": "the zone ID", + "description": "the end AS Number", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "endasn", "required": true, - "type": "uuid" + "type": "long" }, { "description": "the start AS Number", @@ -50316,51 +51230,52 @@ "type": "long" }, { - "description": "the end AS Number", + "description": "the zone ID", "length": 255, - "name": "endasn", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "long" + "type": "uuid" } ], "related": "listASNRanges", "response": [ + {}, { - "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": "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": "Created date", + "name": "created", + "type": "date" }, - {}, { "description": "ID of the AS Number Range", "name": "id", "type": "string" }, { - "description": "Start AS Number", - "name": "startasn", + "description": "End AS Number", + "name": "endasn", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "Created date", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.20.0" @@ -50371,12 +51286,11 @@ "name": "addTungstenFabricNetworkGatewayToLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric logical router uuid", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "logicalrouteruuid", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Tungsten-Fabric network uuid", @@ -50386,51 +51300,52 @@ "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", + "description": "the ID of zone", "length": 255, - "name": "logicalrouteruuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "response": [ { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "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 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": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -50440,11 +51355,12 @@ "name": "listTungstenFabricNic", "params": [ { - "description": "the uuid of Tungsten-Fabric nic", + "description": "the ID of zone", "length": 255, - "name": "nicuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -50453,14 +51369,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -50474,19 +51382,26 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric nic name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric nic name", + "name": "name", + "type": "string" }, { "description": "Tungsten-Fabric provider zone name", @@ -50495,10 +51410,11 @@ }, {}, { - "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", @@ -50508,8 +51424,7 @@ "description": "Tungsten-Fabric nic uuid", "name": "uuid", "type": "string" - }, - {} + } ] }, { @@ -50518,16 +51433,16 @@ "name": "listVmwareDcs", "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" }, @@ -50540,45 +51455,45 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addVmwareDc", "response": [ + {}, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, + {}, { "description": "the Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -50596,18 +51511,19 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "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 uuid of network", @@ -50617,49 +51533,48 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "the minor sequence of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "minorsequence", "required": true, - "type": "uuid" + "type": "integer" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric policy name", - "name": "name", - "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" }, + {}, { - "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": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, - {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -50673,63 +51588,63 @@ "name": "listZones", "params": [ { - "description": "the name of the zone", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "name", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "flag to display the capacity of the zones", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "showcapacities", + "name": "ids", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "list" }, { - "description": "", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "page", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the domain associated with the zone", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "since": "4.3", - "type": "map" + "type": "string" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "the name of the zone", "length": 255, - "name": "networktype", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the zone", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", + "name": "tags", "required": false, - "type": "uuid" + "since": "4.3", + "type": "map" }, { - "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.", @@ -50739,35 +51654,40 @@ "type": "boolean" }, { - "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": "flag to display the resource image for the zones", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "pagesize", + "name": "networktype", "required": false, - "type": "integer" + "type": "string" } ], "related": "createZone,listZones", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { "description": "the second IPv6 DNS for the Zone", @@ -50775,8 +51695,8 @@ "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { @@ -50785,24 +51705,54 @@ "type": "map" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { "description": "the display text of the zone", @@ -50810,13 +51760,23 @@ "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { @@ -50824,8 +51784,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -50834,23 +51794,18 @@ "type": "string" }, { - "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -50859,8 +51814,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -50868,47 +51823,93 @@ "name": "domainpath", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone id", + "name": "id", + "type": "string" }, + {}, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "Zone description", + "name": "description", "type": "string" }, - {}, { "description": "the first DNS for the Zone", "name": "dns1", "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": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -50917,9 +51918,24 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { "description": "the total capacity available", @@ -50927,9 +51943,9 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { "description": "The tag for the capacity type", @@ -50942,108 +51958,148 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" } ], "type": "list" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + } + ] + }, + { + "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, "type": "string" }, { - "description": "Zone id", - "name": "id", + "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": "Network domain name for the networks in the zone", - "name": "domain", + "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" + } + ], + "related": "listQuarantinedIps,updateQuarantinedIp", + "response": [ + {}, + { + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "Zone description", - "name": "description", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, {}, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19" + }, + { + "description": "Deletes the backup schedule of a VM", + "isasync": false, + "name": "deleteBackupSchedule", + "params": [ { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "ID of the schedule", + "length": 255, + "name": "id", + "related": "listBackupSchedule", + "required": false, + "since": "4.20.1", + "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", @@ -51051,106 +52107,111 @@ "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - } - ] + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {} + ], + "since": "4.14.0" }, { - "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", + "description": "Lists external backup offerings of the provider", "isasync": false, - "name": "removeQuarantinedIp", + "name": "listBackupProviderOfferings", "params": [ { - "description": "The reason for removing the public IP address from quarantine prematurely.", + "description": "The zone ID", "length": 255, - "name": "removalreason", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "description": "", "length": 255, - "name": "id", - "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "description": "", "length": 255, - "name": "ipaddress", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" } ], - "related": "listQuarantinedIps,updateQuarantinedIp", + "related": "importBackupOffering,listBackupOfferings,updateBackupOffering", "response": [ + {}, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - }, - { - "description": "ID of the quarantine process.", - "name": "id", + "description": "name for the backup offering", + "name": "name", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "zone ID", + "name": "zoneid", "type": "string" }, - {}, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "zone name", + "name": "zonename", + "type": "string" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "description for the backup offering", + "name": "description", "type": "string" }, { - "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": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "When the quarantine was removed.", - "name": "removed", + "description": "the date this backup offering 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": "ID of the backup offering", + "name": "id", + "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "external ID on the provider side", + "name": "externalid", "type": "string" } ], - "since": "4.19" + "since": "4.14.0" }, { "description": "Releases a Public IP range back to the system pool", @@ -51167,11 +52228,6 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -51183,6 +52239,11 @@ "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", @@ -51229,8 +52290,8 @@ "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { @@ -51239,39 +52300,38 @@ "type": "set" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, - {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { @@ -51280,152 +52340,158 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, + {}, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -51434,13 +52500,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -51449,8 +52515,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -51458,6 +52524,16 @@ "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": "tag value", "name": "value", @@ -51467,44 +52543,94 @@ "type": "list" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "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", @@ -51514,36 +52640,31 @@ "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" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "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", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -51552,8 +52673,8 @@ "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -51562,8 +52683,18 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -51572,59 +52703,19 @@ ], "type": "list" }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, { "description": "zone id of the network", "name": "zoneid", "type": "string" }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, { "description": "Broadcast domain type of the network", "name": "broadcastdomaintype", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { @@ -51633,130 +52724,105 @@ "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "the type of the network", - "name": "type", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "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": "the displaytext of the network", - "name": "displaytext", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "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 date this network was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, - {}, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" } ] }, @@ -51775,85 +52841,29 @@ } ], "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": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", - "params": [ - { - "description": "List by host ID", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" - } - ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", - "response": [ - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, {}, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "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" } - ], - "since": "4.11" + ] }, { "description": "Lists supported methods of network isolation", @@ -51861,18 +52871,18 @@ "name": "listNetworkIsolationMethods", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -51884,25 +52894,81 @@ ], "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": "Network isolation method name", "name": "name", "type": "string" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Lists host HA resources", + "isasync": false, + "name": "listHostHAResources", + "params": [ + { + "description": "List by host ID", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + {}, + {}, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + } ], - "since": "4.2.0" + "since": "4.11" }, { "description": "list Tungsten-Fabric firewall policy", @@ -51910,16 +52976,16 @@ "name": "listTungstenFabricFirewallPolicy", "params": [ { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "keyword", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -51939,22 +53005,27 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "", "length": 255, - "name": "applicationpolicysetuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createTungstenFabricFirewallPolicy", "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", @@ -51966,11 +53037,10 @@ "name": "uuid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "list Tungsten-Fabric firewall rule", @@ -51982,30 +53052,118 @@ "name": "zonename", "type": "string" }, + {}, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Imports a backup offering using a backup provider", + "isasync": true, + "name": "importBackupOffering", + "params": [ + { + "description": "the description of the backup offering", + "length": 255, + "name": "description", + "required": true, + "type": "string" + }, + { + "description": "Whether users are allowed to create adhoc backups and backup schedules", + "length": 255, + "name": "allowuserdrivenbackups", + "required": true, + "type": "boolean" + }, + { + "description": "The backup offering ID (from backup provider side)", + "length": 255, + "name": "externalid", + "required": true, + "type": "string" + }, + { + "description": "the name of the backup offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listBackupOfferings,updateBackupOffering", + "response": [ + {}, + { + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" + }, + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", + "description": "name for the backup offering", + "name": "name", + "type": "string" + }, + { + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the backup offering", + "name": "id", + "type": "string" + }, + { + "description": "description for the backup offering", + "name": "description", + "type": "string" + }, + { + "description": "zone ID", "name": "zoneid", - "type": "long" + "type": "string" + }, + { + "description": "zone name", + "name": "zonename", + "type": "string" } - ] + ], + "since": "4.14.0" }, { "description": "Deletes a specified domain", "isasync": true, "name": "deleteDomain", "params": [ - { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, { "description": "ID of domain to delete", "length": 255, @@ -52013,9 +53171,21 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" + }, + { + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -52026,17 +53196,12 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, {} ] }, @@ -52053,6 +53218,14 @@ "required": true, "type": "uuid" }, + { + "description": "the ID of the volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + }, { "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, @@ -52067,122 +53240,161 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "the ID of the volume", - "length": 255, - "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": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "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", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "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 disk utilization", - "name": "utilization", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod name of the volume", + "name": "podname", "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": "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the disk volume", - "name": "name", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "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": "true if volume has delete protection.", @@ -52190,55 +53402,79 @@ "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, { "description": "name of the virtual machine", "name": "vmname", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "ID of the disk volume", + "name": "id", "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "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", @@ -52246,33 +53482,33 @@ "type": "map" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { @@ -52286,222 +53522,151 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "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": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the 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": "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "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": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the state of the disk volume", + "name": "state", "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" } ], "since": "3.0.0" @@ -52511,13 +53676,6 @@ "isasync": true, "name": "createTungstenFabricApplicationPolicySet", "params": [ - { - "description": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -52525,29 +53683,21 @@ "related": "createZone,listZones", "required": true, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" }, { - "description": "Tungsten-Fabric policy name", + "description": "Tungsten-Fabric application policy set name", + "length": 255, "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -52560,113 +53710,33 @@ "name": "firewallpolicy", "type": "list" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" - } - ] - }, - { - "description": "Deletes an existing Bgp Peer.", - "isasync": true, - "name": "deleteBgpPeer", - "params": [ - { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "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 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 ID of the host", - "name": "hostid", - "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", + "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 host HA provider", - "name": "haprovider", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, {} - ], - "since": "4.11" + ] }, { "description": "A command to list events.", @@ -52674,48 +53744,56 @@ "name": "listEvents", "params": [ { - "description": "", + "description": "the duration of the event", "length": 255, - "name": "pagesize", + "name": "duration", "required": false, "type": "integer" }, { - "description": "the time the event was entered", + "description": "", "length": 255, - "name": "entrytime", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list 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": "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 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": "enddate", + "name": "startid", + "related": "listEvents", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "the ID of the resource associated with the event", + "description": "List by keyword", "length": 255, - "name": "resourceid", + "name": "keyword", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "true to list archived events otherwise false", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "archived", "required": false, - "type": "uuid" + "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.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { "description": "the event type (see event types)", @@ -52725,18 +53803,19 @@ "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "level", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the time the event was entered", "length": 255, - "name": "keyword", + "name": "entrytime", "required": false, - "type": "string" + "type": "integer" }, { "description": "the type of the resource associated with the event", @@ -52747,17 +53826,9 @@ "type": "string" }, { - "description": "true to list archived events otherwise false", - "length": 255, - "name": "archived", - "required": false, - "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 ID of the event", "length": 255, - "name": "startid", + "name": "id", "related": "listEvents", "required": false, "type": "uuid" @@ -52770,65 +53841,95 @@ "type": "date" }, { - "description": "the ID of the event", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "listEvents", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "account", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the duration of the event", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "duration", + "name": "level", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the ID of the resource associated with the event", "length": 255, - "name": "page", + "name": "resourceid", "required": false, - "type": "integer" + "since": "4.17.0", + "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" } ], "related": "", "response": [ { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", - "name": "username", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the id of the account's domain", + "name": "domainid", + "type": "string" + }, + { + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" + }, + {}, + { + "description": "the name of the resource", + "name": "resourcename", + "type": "string" + }, + { + "description": "the type of the event (see event types)", + "name": "type", + "type": "string" + }, + { + "description": "the name of the account's domain", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, { @@ -52837,88 +53938,152 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - {}, { "description": "the state of the event", "name": "state", "type": "state" }, { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the event", + "name": "id", + "type": "string" }, { "description": "the date the event was created", "name": "created", "type": "date" }, + {}, { - "description": "path of the Domain the account's domain belongs to", - "name": "domainpath", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "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 resource", - "name": "resourceid", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "description": "a brief description of the event", - "name": "description", + "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": "the type of the resource", - "name": "resourcetype", + "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 type of the event (see event types)", - "name": "type", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, + {}, { - "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 account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, { - "description": "the name of the account's domain", - "name": "domain", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the host HA provider", + "name": "haprovider", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11" + }, + { + "description": "Deletes an existing Bgp Peer.", + "isasync": true, + "name": "deleteBgpPeer", + "params": [ + { + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.20.0" }, { "description": "Creates resource tag(s)", @@ -52932,6 +54097,13 @@ "required": false, "type": "string" }, + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, { "description": "list of resources to create the tags for", "length": 255, @@ -52945,13 +54117,6 @@ "name": "tags", "required": true, "type": "map" - }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" } ], "response": [ @@ -52960,22 +54125,22 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, {} ], "since": "4.0.0" @@ -52996,7 +54161,6 @@ ], "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ - {}, { "description": "the id of the internal load balancer element", "name": "id", @@ -53013,14 +54177,15 @@ "type": "integer" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -53041,11 +54206,6 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -53056,12 +54216,17 @@ "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" } ] }, @@ -53080,27 +54245,27 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "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" } ] }, @@ -53109,6 +54274,13 @@ "isasync": true, "name": "generateAlert", "params": [ + { + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" + }, { "description": "Name of the alert", "length": 255, @@ -53116,6 +54288,13 @@ "required": true, "type": "string" }, + { + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" + }, { "description": "Zone id for which alert is generated", "length": 255, @@ -53124,13 +54303,6 @@ "required": false, "type": "uuid" }, - { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, - "type": "string" - }, { "description": "Pod id for which alert is generated", "length": 255, @@ -53138,33 +54310,26 @@ "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" - }, - { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" } ], "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": "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", @@ -53179,23 +54344,23 @@ "name": "ldapConfig", "params": [ { - "description": "Enter the password.", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "bindpass", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "port", + "name": "searchbase", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "binddn", + "name": "truststore", "required": false, "type": "string" }, @@ -53207,50 +54372,55 @@ "type": "boolean" }, { - "description": "Enter the password for trust store.", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "truststorepass", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "searchbase", + "name": "queryfilter", "required": false, "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Enter the password.", "length": 255, - "name": "hostname", + "name": "bindpass", "required": false, "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "queryfilter", + "name": "binddn", "required": false, "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "Enter the password for trust store.", "length": 255, - "name": "ssl", + "name": "truststorepass", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Enter the path to trust certificates store.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "truststore", + "name": "hostname", "required": false, "type": "string" } ], "related": "ldapRemove", "response": [ + { + "description": "DN password", + "name": "bindpass", + "type": "string" + }, { "description": "Specify the LDAP port if required, default is 389", "name": "port", @@ -53261,24 +54431,26 @@ "name": "jobid", "type": "string" }, + {}, + {}, { "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": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "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", + "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { @@ -53286,18 +54458,11 @@ "name": "binddn", "type": "string" }, - {}, - { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", - "type": "string" - }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -53317,15 +54482,14 @@ ], "related": "", "response": [ - {}, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", - "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" }, { @@ -53334,8 +54498,8 @@ "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { @@ -53343,17 +54507,18 @@ "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 Storage Policy", + "name": "id", + "type": "string" }, - {}, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -53365,33 +54530,33 @@ "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": true, "type": "uuid" } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "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" + }, {} ] }, @@ -53407,13 +54572,6 @@ "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" - }, { "description": "vpc offering ID", "length": 255, @@ -53422,6 +54580,13 @@ "required": true, "type": "uuid" }, + { + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" + }, { "description": "the ID of the vpc", "length": 255, @@ -53433,75 +54598,91 @@ ], "related": "listVPCs,createVPC,listVPCs,updateVPC", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "zone id of the vpc", "name": "zoneid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "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 domain id of the VPC owner", + "name": "domainid", + "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, + {}, { - "description": "the 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 domain name of the owner", - "name": "domain", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { "description": "the owner of the VPC", @@ -53513,132 +54694,161 @@ "name": "state", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "if this VPC has redundant router", "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "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": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, - {}, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "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": "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": "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" } ], "type": "list" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the provider name", @@ -53646,8 +54856,8 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -53656,18 +54866,18 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", @@ -53694,28 +54904,18 @@ "type": "list" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the project name of the VPC", - "name": "project", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { @@ -53724,44 +54924,9 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "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 second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" } ], "since": "4.11.0" @@ -53782,8 +54947,13 @@ ], "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -53792,16 +54962,11 @@ "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" - }, {} ] }, @@ -53827,11 +54992,32 @@ ], "related": "addAnnotation,listAnnotations,removeAnnotation", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, { "description": "The (uu)id of the user that entered the annotation", "name": "userid", "type": "string" }, + {}, { "description": "True if the annotation is available for admins only", "name": "adminsonly", @@ -53839,18 +55025,13 @@ }, {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { @@ -53858,102 +55039,23 @@ "name": "annotation", "type": "string" }, - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, { "description": "the removal timestamp for this annotation", "name": "removed", "type": "date" }, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "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": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" } ], - "since": "4.11" + "since": "4.16" }, { "description": "Updates a configuration.", @@ -53961,26 +55063,26 @@ "name": "updateConfiguration", "params": [ { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "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", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, @@ -53992,18 +55094,18 @@ "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -54015,10 +55117,10 @@ "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } @@ -54026,70 +55128,58 @@ "related": "listConfigurations", "response": [ { - "description": "the subgroup of the configuration", - "name": "subgroup", - "type": "string" - }, - { - "description": "the description of the configuration", - "name": "description", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, - {}, { "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", "name": "scope", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, - { - "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 category of the configuration", - "name": "category", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the description of the configuration", + "name": "description", "type": "string" }, - {}, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { @@ -54097,50 +55187,103 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the group of the configuration", - "name": "group", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the value of the configuration", + "name": "value", "type": "string" - } + }, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, + {} ] }, { - "description": "Lists volume stats", - "isasync": false, - "name": "listVolumesUsageHistory", + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", "params": [ { - "description": "the ID of the volume.", + "description": "ID of the host", "length": 255, - "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" }, { - "description": "", + "description": "HA provider", "length": 255, - "name": "page", - "required": false, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "enableHAForHost,disableHAForHost", + "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": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, + {}, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + } + ], + "since": "4.11" + }, + { + "description": "Lists volume stats", + "isasync": false, + "name": "listVolumesUsageHistory", + "params": [ { "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, @@ -54155,6 +55298,13 @@ "required": false, "type": "integer" }, + { + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, { "description": "List by keyword", "length": 255, @@ -54163,9 +55313,9 @@ "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, @@ -54176,37 +55326,52 @@ "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "list" + }, + { + "description": "the ID of the volume.", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "name": "name", "type": "string" }, + {}, { "description": "the ID of the volume", "name": "id", "type": "string" }, { - "description": "the name of the volume", - "name": "name", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.18.0" }, @@ -54215,21 +55380,6 @@ "isasync": false, "name": "dedicatePublicIpRange", "params": [ - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "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, @@ -54245,6 +55395,21 @@ "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "required": true, "type": "uuid" + }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" } ], "related": "createVlanIpRange,updateVlanIpRange", @@ -54254,158 +55419,190 @@ "name": "gateway", "type": "string" }, + {}, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network id of vlan range", + "name": "networkid", "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": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "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 gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, + { + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the ID or VID of the VLAN.", "name": "vlan", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ] }, { - "description": "Adds API permissions to a project role", + "description": "Deletes an empty Bucket.", "isasync": false, - "name": "createProjectRolePermission", + "name": "deleteBucket", "params": [ { - "description": "ID of the project role", + "description": "The ID of the Bucket", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "id", + "related": "createBucket,listBuckets", "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" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds API permissions to a project role", + "isasync": false, + "name": "createProjectRolePermission", + "params": [ { "description": "ID of project where project role permission is to be created", "length": 255, @@ -54421,6 +55618,13 @@ "required": true, "type": "string" }, + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + }, { "description": "The description of the role permission", "length": 255, @@ -54429,11 +55633,12 @@ "type": "string" }, { - "description": "The API name or wildcard rule such as list*", + "description": "ID of the project role", "length": 255, - "name": "rule", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listProjectRolePermissions", @@ -54444,89 +55649,49 @@ "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the api name or wildcard rule", + "name": "rule", "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 permission type of the api name or wildcard rule, allow/deny", "name": "permission", "type": "string" }, + {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, + {}, { "description": "the ID of the project", "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, - { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" - } - ], - "since": "4.15.0" - }, - { - "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": "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.19.0" + "since": "4.15.0" }, { "description": "Create a console endpoint to connect to a VM console", @@ -54551,9 +55716,15 @@ ], "related": "", "response": [ + {}, { - "description": "the console url", - "name": "url", + "description": "true if the console endpoint is generated properly", + "name": "success", + "type": "boolean" + }, + { + "description": "details in case of an error", + "name": "details", "type": "string" }, { @@ -54561,26 +55732,20 @@ "name": "websocket", "type": "consoleendpointwebsocketresponse" }, - { - "description": "true if the console endpoint is generated properly", - "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": "details in case of an error", - "name": "details", + "description": "the console url", + "name": "url", "type": "string" } ], @@ -54591,14 +55756,6 @@ "isasync": false, "name": "updateProjectRolePermission", "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" - }, { "description": "Rule permission, can be: allow or deny", "length": 255, @@ -54606,6 +55763,14 @@ "required": false, "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": "listProjectRolePermissions", + "required": false, + "type": "list" + }, { "description": "Project Role permission rule id", "length": 255, @@ -54623,36 +55788,36 @@ "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "ID of the project role", "length": 255, - "name": "ruleorder", - "related": "listProjectRolePermissions", - "required": false, - "type": "list" + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.0" @@ -54663,18 +55828,10 @@ "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": "Name of the user to be added to the project", + "description": "Project role type to be assigned to the user - Admin/Regular", "length": 255, - "name": "username", - "required": true, + "name": "roletype", + "required": false, "type": "string" }, { @@ -54686,12 +55843,20 @@ "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular", + "description": "Name of the user to be added to the project", "length": 255, - "name": "roletype", - "required": false, + "name": "username", + "required": true, "type": "string" }, + { + "description": "ID of the project to add the user to", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + }, { "description": "email ID of user to which invitation to the project is going to be sent", "length": 255, @@ -54701,6 +55866,7 @@ } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -54711,18 +55877,17 @@ "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" }, @@ -54741,23 +55906,23 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "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", @@ -54772,44 +55937,44 @@ "name": "deleteTungstenFabricFirewallPolicy", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "firewallpolicyuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "the ID of zone", "length": 255, - "name": "firewallpolicyuuid", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -54828,102 +55993,111 @@ ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ - {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "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": "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 userdata used for the VM", - "name": "userdataid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Guest vm Boot Type", + "name": "boottype", + "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 list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "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 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": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "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 domain associated with the tag", + "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -54932,95 +56106,100 @@ "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", - "type": "string" + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the 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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { "description": "OS name of the vm", "name": "osdisplayname", @@ -55032,8 +56211,18 @@ "type": "integer" }, { - "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { @@ -55042,96 +56231,70 @@ "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + {}, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, { - "description": "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { "description": "the user's name who deployed the virtual machine", @@ -55139,247 +56302,189 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, + {}, { - "description": "path of the domain in which the virtual machine exists", - "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": "the project name of the vm", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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 availability zone for the virtual machine", + "name": "zonename", + "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 virtual machine", "name": "id", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "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 list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the nic", + "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "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 domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the description of the security group", + "name": "description", "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", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -55388,67 +56493,62 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project 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": "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 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 project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "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 id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "security group name", @@ -55456,18 +56556,13 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -55476,126 +56571,79 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" } ], "type": "set" }, { - "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 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 starting IP of the security group rule", - "name": "startport", + "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": "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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "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 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 key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -55604,51 +56652,46 @@ "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 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": "the type of the ICMP message response", - "name": "icmptype", + "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 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": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -55657,59 +56700,91 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" - }, + } + ], + "type": "set" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -55718,170 +56793,265 @@ "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the group ID of the virtual machine", + "name": "groupid", "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - {}, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the 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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "the format of the template for the virtual machine", "name": "templateformat", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "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 name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -55890,33 +57060,33 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" } ] @@ -55936,18 +57106,12 @@ } ], "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", @@ -55957,6 +57121,12 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0" @@ -55967,26 +57137,19 @@ "name": "updateBgpPeer", "params": [ { - "description": "The IPv6 address of the Bgp Peer.", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "ip6address", + "name": "asnumber", "required": false, - "type": "string" + "type": "long" }, { - "description": "The IPv4 address of the Bgp Peer.", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "ipaddress", + "name": "password", "required": false, "type": "string" }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, { "description": "Id of the Bgp Peer", "length": 255, @@ -55996,54 +57159,41 @@ "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 password of the Bgp Peer.", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "password", + "name": "ip6address", "required": false, "type": "string" }, { - "description": "BGP peer details in key/value pairs.", + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "details", + "name": "ipaddress", "required": false, - "type": "map" - } - ], - "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", - "response": [ - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the project name of the bgp peer", - "name": "project", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" - }, + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + } + ], + "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "response": [ { "description": "date when this bgp peer was created.", "name": "created", "type": "date" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the domain ID of the bgp peer", "name": "domainid", @@ -56055,50 +57205,70 @@ "type": "map" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" }, { "description": "password of bgp peer", "name": "password", "type": "string" }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "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", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, - {}, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" } ], @@ -56113,14 +57283,21 @@ "description": "the ID of lb rule", "length": 255, "name": "lbruleid", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": true, "type": "uuid" }, { - "description": "loadbalancer health monitor expected code", + "description": "loadbalancer health monitor timeout", "length": 255, - "name": "expectedcode", + "name": "timeout", + "required": true, + "type": "integer" + }, + { + "description": "loadbalancer health monitor http method", + "length": 255, + "name": "httpmethodtype", "required": false, "type": "string" }, @@ -56132,17 +57309,17 @@ "type": "string" }, { - "description": "loadbalancer health monitor interval", + "description": "loadbalancer health monitor expected code", "length": 255, - "name": "interval", - "required": true, - "type": "integer" + "name": "expectedcode", + "required": false, + "type": "string" }, { - "description": "loadbalancer health monitor http method", + "description": "loadbalancer health monitor type", "length": 255, - "name": "httpmethodtype", - "required": false, + "name": "type", + "required": true, "type": "string" }, { @@ -56153,32 +57330,25 @@ "type": "integer" }, { - "description": "loadbalancer health monitor timeout", + "description": "loadbalancer health monitor interval", "length": 255, - "name": "timeout", + "name": "interval", "required": true, "type": "integer" - }, - { - "description": "loadbalancer health monitor type", - "length": 255, - "name": "type", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, {}, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the health monitor retry", @@ -56190,31 +57360,15 @@ "name": "uuid", "type": "string" }, - { - "description": "the health monitor type", - "name": "type", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the health monitor timeout", "name": "timeout", "type": "int" }, { - "description": "the health monitor http method", - "name": "httpmethod", - "type": "string" - }, - {}, - { - "description": "the LB rule ID", - "name": "lbruleid", - "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", @@ -56222,24 +57376,40 @@ "type": "integer" }, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor interval", + "name": "interval", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + { + "description": "the health monitor http method", + "name": "httpmethod", + "type": "string" + }, + {}, { "description": "the health monitor ID", "name": "id", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the health monitor type", + "name": "type", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" } ] }, @@ -56252,16 +57422,17 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "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", @@ -56273,13 +57444,12 @@ "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" + }, + {} ] }, { @@ -56287,13 +57457,6 @@ "isasync": true, "name": "updateProjectInvitation", "params": [ - { - "description": "if true, accept the invitation, decline if false. True by default", - "length": 255, - "name": "accept", - "required": false, - "type": "boolean" - }, { "description": "User UUID, required for adding account from external provisioning system", "length": 255, @@ -56303,11 +57466,11 @@ "type": "uuid" }, { - "description": "list invitations for specified account; this parameter has to be specified with domainId", + "description": "if true, accept the invitation, decline if false. True by default", "length": 255, - "name": "token", + "name": "accept", "required": false, - "type": "string" + "type": "boolean" }, { "description": "account that is joining the project", @@ -56323,30 +57486,37 @@ "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", + "description": "list invitations for specified account; this parameter has to be specified with domainId", + "length": 255, + "name": "token", + "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "3.0.0" @@ -56368,55 +57538,106 @@ "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "response": [ { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, - {}, { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { "description": " the date the snapshot was created", @@ -56424,34 +57645,24 @@ "type": "date" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the project name of the snapshot", - "name": "project", + "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": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "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": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { "description": "ID of the disk volume", @@ -56459,43 +57670,38 @@ "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "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": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -56504,96 +57710,60 @@ "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + {}, { "description": "ID of the snapshot", "name": "id", "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "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", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" } ] @@ -56611,43 +57781,43 @@ "type": "long" }, { - "description": "the ID of the condition.", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, - "name": "id", - "related": "listConditions", + "name": "relationaloperator", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "description": "the ID of the condition.", "length": 255, - "name": "relationaloperator", + "name": "id", + "related": "listConditions", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "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" } ], "since": "4.18.0" @@ -56658,18 +57828,18 @@ "name": "listRegions", "params": [ { - "description": "List Region by region name.", + "description": "List Region by region ID.", "length": 255, - "name": "name", + "name": "id", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List Region by region ID.", + "description": "List Region by region name.", "length": 255, - "name": "id", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -56681,33 +57851,29 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "addRegion,updateRegion", "response": [ - { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the region", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -56715,6 +57881,16 @@ "name": "endpoint", "type": "string" }, + { + "description": "the name of the region", + "name": "name", + "type": "string" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, { "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", @@ -56725,13 +57901,7 @@ "name": "id", "type": "integer" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -56760,7 +57930,7 @@ "description": "destination Host ID to migrate VM to", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, @@ -56776,215 +57946,220 @@ "related": "startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "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", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, - {}, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the public IP address for the system VM", + "name": "publicip", "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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, + { + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, { "description": "the name of the service offering of the system virtual machine.", "name": "serviceofferingname", "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 template name for the system VM", - "name": "templatename", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the 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 job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, - {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "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 systemvm agent version", - "name": "version", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" } ] @@ -56995,34 +58170,27 @@ "name": "listCounters", "params": [ { - "description": "Name of the counter.", + "description": "ID of the Counter.", "length": 255, - "name": "name", + "name": "id", + "related": "createCounter,listCounters", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Source of the counter.", + "description": "", "length": 255, - "name": "source", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "Source of the counter.", "length": 255, - "name": "keyword", + "name": "source", "required": false, "type": "string" }, - { - "description": "ID of the Counter.", - "length": 255, - "name": "id", - "related": "createCounter,listCounters", - "required": false, - "type": "uuid" - }, { "description": "Network provider of the counter.", "length": 255, @@ -57034,39 +58202,46 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "Name of the counter.", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "createCounter", "response": [ - {}, { - "description": "Provider of the counter.", - "name": "provider", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "Source of the counter.", - "name": "source", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { @@ -57075,20 +58250,20 @@ "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, {}, + { + "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" - }, - { - "description": "Name of the counter.", - "name": "name", - "type": "string" } ] }, @@ -57098,19 +58273,19 @@ "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", @@ -57122,8 +58297,8 @@ "type": "integer" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -57138,8 +58313,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" } ], @@ -57151,16 +58326,9 @@ "name": "removeTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, - { - "description": "the uuid of vms", + "description": "the uuid of networks", "length": 255, - "name": "vmuuid", + "name": "networkuuid", "required": false, "type": "list" }, @@ -57172,9 +58340,9 @@ "type": "string" }, { - "description": "the uuid of networks", + "description": "the uuid of nics", "length": 255, - "name": "networkuuid", + "name": "nicuuid", "required": false, "type": "list" }, @@ -57194,23 +58362,36 @@ "type": "string" }, { - "description": "the uuid of nics", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "nicuuid", + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of vms", + "length": 255, + "name": "vmuuid", "required": false, "type": "list" } ], "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", "response": [ + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" }, { @@ -57229,30 +58410,24 @@ "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" } ] @@ -57263,27 +58438,18 @@ "name": "listVirtualRouterElements", "params": [ { - "description": "list virtual router elements by id", - "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "required": false, - "type": "uuid" - }, - { - "description": "list virtual router elements by network service provider id", + "description": "", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list network offerings by enabled state", "length": 255, - "name": "pagesize", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", @@ -57293,11 +58459,12 @@ "type": "integer" }, { - "description": "list network offerings by enabled state", + "description": "list virtual router elements by network service provider id", "length": 255, - "name": "enabled", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -57305,15 +58472,18 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "list virtual router elements by id", + "length": 255, + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", + "required": false, + "type": "uuid" } ], "related": "configureVirtualRouterElement", "response": [ - { - "description": "the account associated with the provider", - "name": "account", - "type": "string" - }, { "description": "the physical network service provider id of the provider", "name": "nspid", @@ -57324,28 +58494,32 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { "description": "the domain associated with the provider", "name": "domain", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, { "description": "the domain ID associated with the provider", "name": "domainid", @@ -57357,15 +58531,16 @@ "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the account associated with the provider", + "name": "account", "type": "string" - } + }, + {} ] }, { @@ -57384,10 +58559,11 @@ ], "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", @@ -57399,11 +58575,10 @@ "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -57414,19 +58589,11 @@ "name": "createRoutingFirewallRule", "params": [ { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "The network of the VM the firewall rule will be created for", + "description": "the starting port of firewall rule", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "startport", + "required": false, + "type": "integer" }, { "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", @@ -57436,46 +58603,54 @@ "type": "list" }, { - "description": "type of the ICMP message being sent", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "icmptype", + "name": "fordisplay", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ending port of firewall rule", + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "endport", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the starting port of firewall rule", + "description": "error code for this ICMP message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "The network of the VM the firewall rule will be created for", "length": 255, - "name": "icmpcode", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", "required": false, "type": "integer" }, { - "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "type of the ICMP message being sent", "length": 255, - "name": "traffictype", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", @@ -57485,57 +58660,16 @@ "type": "list" } ], - "related": "updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,listRoutingFirewallRules", "response": [ - { - "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 starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "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 vm ip address for the port forwarding rule", "name": "vmguestip", "type": "string" }, - {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -57543,26 +58677,6 @@ "name": "cidrlist", "type": "string" }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, {}, { "description": "the VM name for the port forwarding rule", @@ -57570,13 +58684,8 @@ "type": "string" }, { - "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 VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -57584,43 +58693,43 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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" }, { @@ -57629,8 +58738,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -57640,6 +58749,72 @@ } ], "type": "list" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" } ], "since": "4.20.0" @@ -57649,21 +58824,6 @@ "isasync": false, "name": "linkAccountToLdap", "params": [ - { - "description": "The id of the domain that is to contain the linked account.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": true, - "type": "string" - }, { "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, @@ -57694,43 +58854,52 @@ "required": false, "type": "string" }, + { + "description": "The id of the domain that is to contain the linked account.", + "length": 255, + "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" + }, + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, + "type": "string" } ], "related": "", "response": [ - { - "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": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, + {}, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "ldapdomain", @@ -57745,7 +58914,13 @@ "description": "Domain Admin accountId that is created", "name": "accountid", "type": "string" - } + }, + { + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", + "type": "string" + }, + {} ], "since": "4.11.0" }, @@ -57758,7 +58933,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -57766,14 +58941,14 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 driver for the host", + "name": "driver", + "type": "string" }, { "description": "the out-of-band management interface password", @@ -57781,30 +58956,29 @@ "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", + "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 powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { "description": "the out-of-band management action (if issued)", @@ -57812,26 +58986,27 @@ "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.9.0" }, @@ -57844,36 +59019,32 @@ "description": "host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the host", - "name": "name", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -57882,14 +59053,19 @@ "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { "description": "the hypervisor version", @@ -57897,51 +59073,61 @@ "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "capabilities of the host", + "name": "capabilities", + "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": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, { "description": "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" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -57955,95 +59141,60 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "events available for the host", + "name": "events", "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 in percentage", - "name": "memoryallocatedpercentage", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, - {}, { - "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 resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, { "description": "comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { @@ -58052,114 +59203,143 @@ "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "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 cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the amount of the host's 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": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { @@ -58168,24 +59348,19 @@ "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "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" }, { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", @@ -58193,53 +59368,53 @@ "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "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", + "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "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", - "name": "cpuwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" } ], @@ -58277,18 +59452,18 @@ "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" + } ], "since": "4.20.0" }, @@ -58297,14 +59472,6 @@ "isasync": false, "name": "createSecurityGroup", "params": [ - { - "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": "name of the security group", "length": 255, @@ -58313,17 +59480,18 @@ "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "Create security group for project", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Create security group for project", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, @@ -58333,29 +59501,36 @@ "name": "description", "required": false, "type": "string" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "updateSecurityGroup", "response": [ { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -58372,25 +59547,15 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -58401,13 +59566,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -58416,13 +59586,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 project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -58431,44 +59601,74 @@ "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": "tag key name", "name": "key", "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 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" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "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 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 id of the security group rule", - "name": "ruleid", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -58476,38 +59676,23 @@ "name": "endport", "type": "integer" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the 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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -58516,8 +59701,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -58526,13 +59711,18 @@ "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -58541,21 +59731,21 @@ "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -58564,64 +59754,23 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - {}, { "description": "the project id of the group", "name": "projectid", @@ -58631,24 +59780,19 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -58662,13 +59806,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -58677,21 +59821,52 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" } ] @@ -58712,15 +59887,25 @@ ], "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network ID", + "name": "networkid", + "type": "string" }, { - "description": "the account the network is available for", - "name": "account", + "description": "the ID of project the network is available for", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain to which the network belongs", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the name of the domain to which the network belongs", + "name": "domain", "type": "string" }, { @@ -58729,38 +59914,75 @@ "type": "string" }, { - "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the network ID", - "name": "networkid", + "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", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Removes a VM from any existing backup offering", + "isasync": true, + "name": "removeVirtualMachineFromBackupOffering", + "params": [ + { + "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {} ], - "since": "4.17.0" + "since": "4.14.0" }, { "description": "Lists site 2 site vpn gateways", @@ -58768,62 +59990,62 @@ "name": "listVpnGateways", "params": [ { - "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": "id of vpc", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "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": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "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": "activateProject,createProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { @@ -58835,31 +60057,31 @@ "type": "uuid" }, { - "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": "id of vpc", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "createVpnGateway,updateVpnGateway", "response": [ { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { @@ -58868,8 +60090,18 @@ "type": "date" }, { - "description": "the public IP address", - "name": "publicip", + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -58878,29 +60110,30 @@ "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the public IP address", + "name": "publicip", "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 vpn gateway ID", - "name": "id", + "description": "the owner", + "name": "account", "type": "string" }, + {}, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, - {}, { - "description": "the project name", - "name": "project", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -58909,21 +60142,10 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the owner", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -58932,19 +60154,19 @@ "name": "moveUser", "params": [ { - "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", + "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": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", + "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", "length": 255, - "name": "account", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { "description": "id of the user to be moved.", @@ -58957,26 +60179,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", "name": "displaytext", "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.11" @@ -58990,29 +60212,29 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -59041,13 +60263,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "connection is passive or not", - "length": 255, - "name": "passive", - "required": false, - "type": "boolean" - }, { "description": "id of the customer gateway", "length": 255, @@ -59055,38 +60270,45 @@ "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "required": true, "type": "uuid" + }, + { + "description": "connection is passive or not", + "length": 255, + "name": "passive", + "required": false, + "type": "boolean" } ], "related": "updateVpnConnection", "response": [ { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "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": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -59095,43 +60317,54 @@ "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + {}, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the project name", - "name": "project", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { @@ -59140,65 +60373,54 @@ "type": "date" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project id", - "name": "projectid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "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 connection ID", "name": "id", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, {}, - {}, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "type": "string" } ] @@ -59215,6 +60437,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "brocade vcs switch ID", "length": 255, @@ -59229,100 +60458,154 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ + {}, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "state of the network", "name": "state", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { @@ -59330,28 +60613,48 @@ "name": "traffictype", "type": "string" }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "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": "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -59360,13 +60663,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -59380,37 +60683,47 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { "description": "ACL name associated with the VPC network", @@ -59418,18 +60731,8 @@ "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 details of the network", - "name": "details", - "type": "map" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { @@ -59438,58 +60741,43 @@ "type": "set" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "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", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the id of the network", + "name": "id", "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": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { @@ -59498,154 +60786,88 @@ "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "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": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the project id of the ipaddress", + "name": "projectid", "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": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "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": "the name of the network", + "name": "name", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { @@ -59653,86 +60875,91 @@ "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the service name", + "name": "name", + "type": "string" }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "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": "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", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the provider name", "name": "name", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" }, { "description": "The Ipv6 routing type of network offering", @@ -59740,34 +60967,34 @@ "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "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 external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ] @@ -59778,11 +61005,26 @@ "name": "listWebhookDeliveries", "params": [ { - "description": "The event type of the Webhook delivery", + "description": "", "length": 255, - "name": "eventtype", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "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.", @@ -59799,11 +61041,11 @@ "type": "date" }, { - "description": "", + "description": "The event type of the Webhook delivery", "length": 255, - "name": "pagesize", + "name": "eventtype", "required": false, - "type": "integer" + "type": "string" }, { "description": "The ID of the Webhook", @@ -59813,13 +61055,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -59834,14 +61069,6 @@ "related": "listManagementServers", "required": false, "type": "uuid" - }, - { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" } ], "related": "createWebhook", @@ -59851,71 +61078,71 @@ "name": "account", "type": "string" }, - { - "description": "The ID of the Webhook", - "name": "id", - "type": "string" - }, - { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", - "type": "string" - }, { "description": "The date when this Webhook was created", "name": "created", "type": "date" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + }, + { + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, {}, { - "description": "the 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 name of the Webhook", - "name": "name", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "The name of the Webhook", + "name": "name", + "type": "string" }, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { @@ -59924,13 +61151,13 @@ "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -59960,27 +61187,29 @@ "description": "the ID of the host to update", "length": 255, "name": "hostid", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "related": "listDedicatedHosts", "response": [ + {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "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 dedicated resource", @@ -59988,27 +61217,25 @@ "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "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" + } ] }, { @@ -60016,13 +61243,6 @@ "isasync": true, "name": "addGloboDnsHost", "params": [ - { - "description": "Username for GloboDNS", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -60031,6 +61251,13 @@ "required": true, "type": "uuid" }, + { + "description": "Password for GloboDNS", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "GloboDNS url", "length": 255, @@ -60039,30 +61266,30 @@ "type": "string" }, { - "description": "Password for GloboDNS", + "description": "Username for GloboDNS", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -60077,25 +61304,25 @@ "isasync": false, "name": "logout", "params": [], - "related": "", + "related": "samlSlo", "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": "Response description", "name": "description", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -60103,6 +61330,13 @@ "isasync": false, "name": "importRole", "params": [ + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, { "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", "length": 255, @@ -60111,10 +61345,10 @@ "type": "map" }, { - "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" }, { @@ -60125,39 +61359,22 @@ "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).", + "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", "length": 255, - "name": "ispublic", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "Creates a role with this unique name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "forced", + "name": "type", "required": false, - "type": "boolean" + "type": "string" } ], "related": "createRole,listRoles,updateRole", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the role", - "name": "state", - "type": "string" - }, { "description": "the name of the role", "name": "name", @@ -60166,8 +61383,13 @@ {}, {}, { - "description": "the ID of the role", - "name": "id", + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -60176,24 +61398,29 @@ "type": "boolean" }, { - "description": "the type of the role", - "name": "type", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the role", + "name": "type", + "type": "string" } ], "since": "4.15.0" @@ -60203,13 +61430,6 @@ "isasync": false, "name": "quotaEmailTemplateUpdate", "params": [ - { - "description": "The quota email template body, max: 500k characters", - "length": 512000, - "name": "templatebody", - "required": true, - "type": "string" - }, { "description": "The locale of the email text", "length": 255, @@ -60218,9 +61438,9 @@ "type": "string" }, { - "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", - "length": 255, - "name": "templatetype", + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", "required": true, "type": "string" }, @@ -60230,31 +61450,38 @@ "name": "templatesubject", "required": true, "type": "string" + }, + { + "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "length": 255, + "name": "templatetype", + "required": true, + "type": "string" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "4.7.0" }, @@ -60263,6 +61490,13 @@ "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, @@ -60270,38 +61504,31 @@ "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", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {}, - {} + } ], "since": "4.20.0" }, @@ -60311,18 +61538,19 @@ "name": "listNetworkServiceProviders", "params": [ { - "description": "list providers by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -60332,49 +61560,43 @@ "type": "integer" }, { - "description": "list providers by state", + "description": "list providers by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "list providers by state", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "state", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addNetworkServiceProvider,listTrafficTypes", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "uuid of the network provider", @@ -60382,26 +61604,31 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + {}, {} ], "since": "3.0.0" @@ -60428,28 +61655,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "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" - } + {} ] }, { @@ -60467,15 +61694,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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -60483,12 +61704,18 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.19.0" }, @@ -60507,17 +61734,6 @@ } ], "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", @@ -60528,6 +61744,17 @@ "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" } ] }, @@ -60540,19 +61767,24 @@ "description": "The ID of the disk volume", "length": 255, "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "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", @@ -60562,11 +61794,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" } ] }, @@ -60575,13 +61802,6 @@ "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, @@ -60589,19 +61809,22 @@ "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": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -60609,41 +61832,45 @@ "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", + "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": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "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", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, + {}, { "description": "When the heuristic was created.", "name": "created", "type": "date" + }, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" } ], "since": "4.19.0" @@ -60664,47 +61891,46 @@ ], "related": "createUser,disableUser,getUser,listUsers,lockUser", "response": [ - {}, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, + {}, { - "description": "the user ID", - "name": "id", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, - {}, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, { - "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 name of the role", - "name": "rolename", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { "description": "the domain name of the user", @@ -60712,13 +61938,8 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -60727,33 +61948,28 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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 timezone user was created in", - "name": "timezone", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "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" }, { @@ -60762,38 +61978,54 @@ "type": "resourceiconresponse" }, { - "description": "the account name of the user", - "name": "account", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + {}, + { + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" } ] @@ -60803,13 +62035,6 @@ "isasync": false, "name": "quotaTariffCreate", "params": [ - { - "description": "Integer value for the usage type of the resource.", - "length": 255, - "name": "usagetype", - "required": true, - "type": "integer" - }, { "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, @@ -60818,26 +62043,12 @@ "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 name", - "length": 65535, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Quota tariff's description.", - "length": 65535, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The quota tariff value of the resource as per the default unit.", "length": 255, @@ -60854,64 +62065,71 @@ "type": "integer" }, { - "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "The end date of the quota tariff. If not informed, the tariff will be valid indefinitely. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" - } - ], - "related": "quotaTariffList", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "usageType", - "name": "usageType", - "type": "int" }, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" + "description": "Integer value for the usage type of the resource.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "Quota tariff's name", + "length": 65535, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" - }, + "description": "Quota tariff's description.", + "length": 65535, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "quotaTariffList", + "response": [ { "description": "usageUnit", "name": "usageUnit", "type": "string" }, { - "description": "name", - "name": "name", + "description": "currency", + "name": "currency", "type": "string" }, + {}, { - "description": "description", - "name": "description", + "description": "activation rule of the quota tariff", + "name": "activationRule", + "type": "string" + }, + { + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, + {}, { "description": "usageDiscriminator", "name": "usageDiscriminator", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "usageName", + "name": "usageName", "type": "string" }, { @@ -60919,32 +62137,46 @@ "name": "position", "type": "integer" }, - {}, { - "description": "usageName", - "name": "usageName", + "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": "description", + "name": "description", "type": "string" }, + { + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, { "description": "tariffValue", "name": "tariffValue", "type": "bigdecimal" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "name", + "name": "name", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "the ID of the tariff", + "name": "id", "type": "string" }, + { + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -60970,114 +62202,94 @@ "related": "activateProject,createProject", "response": [ { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "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 vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, { "description": "the total volume available for this project", "name": "volumeavailable", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "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 number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "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 secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { "description": "the total number of virtual machines stopped for this project", @@ -61085,49 +62297,24 @@ "type": "integer" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", + "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 account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { "description": "the id of the project", @@ -61135,9 +62322,9 @@ "type": "string" }, { - "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 project", + "name": "memoryavailable", + "type": "string" }, { "description": "the total number of snapshots available for this project", @@ -61145,44 +62332,41 @@ "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, + {}, + {}, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "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 available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { "description": "the total number of cpu cores owned by project", @@ -61190,32 +62374,32 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { "description": "the list of resource tags associated with vm", "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": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -61224,13 +62408,13 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -61244,34 +62428,82 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - {}, + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the 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", "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "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 number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" } ], "since": "3.0.0" @@ -61284,42 +62516,42 @@ "related": "", "response": [ { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" }, - {}, { "description": "the account name of the api remaining count", "name": "account", "type": "string" }, - { - "description": "the 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": "number of api already issued", - "name": "apiIssued", - "type": "int" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {} + { + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" + }, + { + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + } ] }, { @@ -61337,27 +62569,27 @@ } ], "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "3.0.0" @@ -61368,25 +62600,17 @@ "name": "addVmwareDc", "params": [ { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, - { - "description": "The Zone ID.", + "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": "zoneid", - "related": "createZone,listZones", + "name": "vcenter", "required": true, - "type": "uuid" + "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": "The Username required to connect to resource.", "length": 255, - "name": "vcenter", - "required": true, + "name": "username", + "required": false, "type": "string" }, { @@ -61397,29 +62621,38 @@ "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": "The Zone ID.", + "length": 255, + "name": "zoneid", + "related": "createZone,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 Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, + {}, { - "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 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", @@ -61428,16 +62661,15 @@ }, {}, { - "description": "The VMware Datacenter ID", - "name": "id", + "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" + } ] }, { @@ -61446,11 +62678,20 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "the ending port of Ipv6 firewall rule", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "endport", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the ipv6 firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" }, { "description": "the starting port of Ipv6 firewall rule", @@ -61460,11 +62701,11 @@ "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "traffictype", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", @@ -61475,19 +62716,11 @@ "type": "boolean" }, { - "description": "the ID of the ipv6 firewall rule", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": true, - "type": "uuid" - }, - { - "description": "type of the ICMP message being sent", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "icmptype", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { "description": "error code for this ICMP message", @@ -61497,137 +62730,79 @@ "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "type of the ICMP message being sent", "length": 255, - "name": "customid", + "name": "icmptype", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "cidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "protocol", + "name": "traffictype", "required": false, "type": "string" } ], - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "response": [ { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "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": "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": "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "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 VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "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 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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, {}, { - "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" }, { @@ -61641,38 +62816,95 @@ "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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 ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" }, { - "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 state of the rule", - "name": "state", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" } ] @@ -61683,27 +62915,19 @@ "name": "updateIsoPermissions", "params": [ { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "projectids", - "related": "activateProject,createProject", + "name": "op", "required": false, - "type": "list" + "type": "string" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "ispublic", + "name": "isfeatured", "required": false, "type": "boolean" }, - { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "type": "string" - }, { "description": "the template ID", "length": 255, @@ -61720,32 +62944,35 @@ "type": "boolean" }, { - "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": "list" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "projectids", + "related": "activateProject,createProject", "required": false, "type": "list" } ], "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", @@ -61753,9 +62980,14 @@ "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" } ] }, @@ -61775,25 +63007,25 @@ ], "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" } ] @@ -61819,49 +63051,88 @@ "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": "Sends an email to the user with a token to reset the password using resetPassword command.", + "isasync": false, + "name": "forgotPassword", + "params": [ + { + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "Username", + "length": 255, + "name": "username", + "required": true, + "type": "string" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" } - ] + ], + "since": "4.20.0.0" }, { "description": "List Autonomous Systems Number Ranges", "isasync": false, "name": "listASNRanges", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the zone ID", @@ -61870,32 +63141,22 @@ "related": "createZone,listZones", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "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": "ID of the AS Number Range", - "name": "id", - "type": "string" - }, - { - "description": "End AS Number", - "name": "endasn", - "type": "long" - }, - {}, { "description": "Zone ID", "name": "zoneid", @@ -61906,11 +63167,28 @@ "name": "jobid", "type": "string" }, + { + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" + }, + {}, { "description": "Start AS Number", "name": "startasn", "type": "long" - } + }, + { + "description": "Created date", + "name": "created", + "type": "date" + }, + { + "description": "End AS Number", + "name": "endasn", + "type": "long" + }, + {} ], "since": "4.20.0" }, @@ -61919,6 +63197,13 @@ "isasync": true, "name": "createTungstenFabricTag", "params": [ + { + "description": "Tungsten-Fabric tag type", + "length": 255, + "name": "tagtype", + "required": true, + "type": "string" + }, { "description": "Tungsten-Fabric tag value", "length": 255, @@ -61933,68 +63218,61 @@ "related": "createZone,listZones", "required": true, "type": "uuid" - }, - { - "description": "Tungsten-Fabric tag type", - "length": 255, - "name": "tagtype", - "required": true, - "type": "string" } ], "related": "listTungstenFabricTag,applyTungstenFabricTag", "response": [ { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "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", + "name": "vm", + "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 policy", + "name": "policy", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" }, { "description": "Tungsten-Fabric tag name", "name": "name", "type": "string" - }, - { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" - }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" } ] }, @@ -62004,9 +63282,9 @@ "name": "addOpenDaylightController", "params": [ { - "description": "Api URL of the OpenDaylight Controller.", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, @@ -62019,31 +63297,25 @@ "type": "uuid" }, { - "description": "Username to access the OpenDaylight API", + "description": "Api URL of the OpenDaylight Controller.", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" }, { - "description": "Credential to access the OpenDaylight API", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" } ], "related": "deleteOpenDaylightController", "response": [ - {}, { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the name assigned to the controller", - "name": "name", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { @@ -62051,25 +63323,31 @@ "name": "jobstatus", "type": "integer" }, - { - "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the name assigned to the controller", + "name": "name", + "type": "string" + }, + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {}, + {}, + { + "description": "device id of the controller", + "name": "id", "type": "string" } ] @@ -62079,20 +63357,6 @@ "isasync": false, "name": "createZone", "params": [ - { - "description": "the second DNS for the Zone", - "length": 255, - "name": "dns2", - "required": false, - "type": "string" - }, - { - "description": "the name of the Zone", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the second DNS for IPv6 network in the Zone", "length": 255, @@ -62101,25 +63365,24 @@ "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "internaldns2", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "ip6dns1", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "ip6dns1", - "required": false, + "name": "networktype", + "required": true, "type": "string" }, { @@ -62131,11 +63394,11 @@ "type": "boolean" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the name of the Zone", "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "the guest CIDR address for the Zone", @@ -62145,12 +63408,20 @@ "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 ID of the containing domain, null for public zones", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "Allocation state of this Zone for allocation of new resources", "length": 255, @@ -62159,9 +63430,9 @@ "type": "string" }, { - "description": "Network domain name for the networks in the zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "domain", + "name": "internaldns2", "required": false, "type": "string" }, @@ -62173,10 +63444,10 @@ "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "internaldns1", - "required": true, + "name": "dns2", + "required": false, "type": "string" }, { @@ -62185,48 +63456,111 @@ "name": "securitygroupenabled", "required": false, "type": "boolean" + }, + { + "description": "Network domain name for the networks in the zone", + "length": 255, + "name": "domain", + "required": false, + "type": "string" } ], "related": "listZones", "response": [ { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "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": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, { "description": "true if local storage offering enabled, false otherwise", "name": "localstorageenabled", "type": "boolean" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "The maximum value the MTU can have on the VR's public interfaces", "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { @@ -62234,11 +63568,20 @@ "name": "ismultiarch", "type": "boolean" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" }, { "description": "Meta data associated with the zone (key/value pairs)", @@ -62246,105 +63589,91 @@ "type": "map" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "tag value", + "name": "value", + "type": "string" } ], - "type": "list" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "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" + "type": "set" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { @@ -62353,131 +63682,85 @@ "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - {}, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" - }, - { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], - "type": "set" - }, - { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" + "type": "list" }, { - "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 DNS for the Zone", - "name": "dns1", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { @@ -62493,11 +63776,11 @@ "name": "listDomainChildren", "params": [ { - "description": "flag to display the resource icon for domains", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list children domains by name", @@ -62507,154 +63790,180 @@ "type": "string" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list children domain by parent domain ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "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", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list children domain by parent domain ID.", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "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": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, { "description": "the level of the domain", "name": "level", "type": "integer" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the path of the domain", + "name": "path", + "type": "string" }, + {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "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 networks available to be created for this domain", - "name": "networkavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { @@ -62663,29 +63972,28 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "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 domain", + "name": "memoryavailable", + "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -62693,125 +64001,100 @@ "name": "vmlimit", "type": "string" }, - { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" - }, { "description": "the total number of public ip addresses this domain can acquire", "name": "iplimit", "type": "string" }, - { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the state of the domain", - "name": "state", - "type": "string" - }, - { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - {}, { "description": "the total volume being used by this domain", "name": "volumetotal", "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "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 domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "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 owned by domain", - "name": "cputotal", - "type": "long" + "description": "the ID of the domain", + "name": "id", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the name of the domain", + "name": "name", "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" } ] @@ -62832,22 +64115,22 @@ ], "related": "", "response": [ - { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", - "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 base64 encoded encrypted password of the VM", + "name": "encryptedpassword", + "type": "string" + }, {} ] }, @@ -62860,10 +64143,17 @@ "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, "name": "loadbalancerrulelist", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "list" }, + { + "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "length": 255, + "name": "gslblbruleweightsmap", + "required": false, + "type": "map" + }, { "description": "the ID of the global load balancer rule", "length": 255, @@ -62871,38 +64161,31 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": true, "type": "uuid" - }, - { - "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", - "length": 255, - "name": "gslblbruleweightsmap", - "required": false, - "type": "map" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -62911,9 +64194,23 @@ "name": "addImageStoreS3", "params": [ { - "description": "Connection timeout (milliseconds)", + "description": "S3 access key", "length": 255, - "name": "connectiontimeout", + "name": "accesskey", + "required": true, + "type": "string" + }, + { + "description": "Socket timeout (milliseconds)", + "length": 255, + "name": "sockettimeout", + "required": false, + "type": "integer" + }, + { + "description": "Connection TTL (milliseconds)", + "length": 255, + "name": "connectionttl", "required": false, "type": "integer" }, @@ -62925,53 +64222,46 @@ "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "S3 endpoint", "length": 255, - "name": "usehttps", - "required": false, - "type": "boolean" + "name": "endpoint", + "required": true, + "type": "string" }, { - "description": "S3 secret key", + "description": "Name of the storage bucket", "length": 255, - "name": "secretkey", + "name": "bucket", "required": true, "type": "string" }, { - "description": "Socket timeout (milliseconds)", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "sockettimeout", + "name": "maxerrorretry", "required": false, "type": "integer" }, { - "description": "S3 access key", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "accesskey", - "required": true, - "type": "string" + "name": "connectiontimeout", + "required": false, + "type": "integer" }, { - "description": "S3 endpoint", + "description": "S3 secret key", "length": 255, - "name": "endpoint", + "name": "secretkey", "required": true, "type": "string" }, { - "description": "Connection TTL (milliseconds)", - "length": 255, - "name": "connectionttl", - "required": false, - "type": "integer" - }, - { - "description": "Maximum number of times to retry on error", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "maxerrorretry", + "name": "usehttps", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "Whether TCP keep-alive is used", @@ -62979,41 +64269,43 @@ "name": "usetcpkeepalive", "required": false, "type": "boolean" - }, - { - "description": "Name of the storage bucket", - "length": 255, - "name": "bucket", - "required": true, - "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "response": [ { - "description": "the ID of the image store", - "name": "id", + "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -63021,45 +64313,36 @@ "name": "disksizetotal", "type": "long" }, + {}, { - "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 Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "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 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 Zone ID of the image store", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the url of the image store", + "name": "url", "type": "string" } ], @@ -63071,11 +64354,12 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Hypervisor type", + "description": "(optional) the host ID to upload certificate", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { "description": "Name for the uploaded certificate", @@ -63093,12 +64377,11 @@ "type": "uuid" }, { - "description": "(optional) the host ID to upload certificate", + "description": "Hypervisor type", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { "description": "SSL certificate", @@ -63111,35 +64394,35 @@ "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, + {}, { "description": "the direct download certificate serial num", "name": "serialnum", "type": "string" }, + {}, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { @@ -63147,35 +64430,35 @@ "name": "validity", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the zone name where the certificate is uploaded", "name": "zonename", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the hosts where the certificate is uploaded to", "name": "hostsmap", "type": "list" - }, - { - "description": "the direct download certificate version", - "name": "version", - "type": "string" } ], "since": "4.11.0" @@ -63185,6 +64468,28 @@ "isasync": true, "name": "importUnmanagedInstance", "params": [ + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "the display name of the instance", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "VM nic to network id mapping using keys nic and network", "length": 255, @@ -63192,6 +64497,13 @@ "required": false, "type": "map" }, + { + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" + }, { "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, @@ -63200,24 +64512,24 @@ "type": "boolean" }, { - "description": "the name of the instance as it is known to the hypervisor", + "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": "name", - "required": true, - "type": "string" + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the host name of the instance", "length": 255, - "name": "account", + "name": "hostname", "required": false, "type": "string" }, { - "description": "the host name of the instance", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "hostname", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -63229,28 +64541,13 @@ "type": "uuid" }, { - "description": "the service offering for the virtual machine", + "description": "the cluster ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" }, - { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, - { - "description": "import instance for the project", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject", - "required": false, - "type": "uuid" - }, { "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, @@ -63258,20 +64555,6 @@ "required": false, "type": "map" }, - { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" - }, - { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "the ID of the template for the virtual machine", "length": 255, @@ -63281,202 +64564,282 @@ "type": "uuid" }, { - "description": "the cluster ID", + "description": "the service offering for the virtual machine", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "used to specify the custom parameters.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "details", + "name": "account", "required": false, - "type": "map" + "type": "string" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the project name of the vm", - "name": "project", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the 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": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "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" + } + ], + "type": "set" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the 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": "resource type", - "name": "resourcetype", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 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 egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -63487,14 +64850,24 @@ "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": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -63503,8 +64876,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -63513,8 +64886,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -63526,16 +64899,6 @@ "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" @@ -63546,30 +64909,117 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the 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 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 ending IP of the security group rule ", - "name": "endport", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -63578,13 +65028,23 @@ "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": "security group name", - "name": "securitygroupname", + "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" }, { @@ -63592,277 +65052,123 @@ "name": "tags", "response": [ { - "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": "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": "the domain associated with the tag", - "name": "domain", + "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": "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": "id of the resource", - "name": "resourceid", + "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" }, { - "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": "account owning the security group rule", - "name": "account", - "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" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "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": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", + "description": "the account owning the security group", "name": "account", "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "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": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - {}, - { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the 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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "true if the password rest feature is enabled, false otherwise", @@ -63870,64 +65176,53 @@ "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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 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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - {}, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -63936,68 +65231,49 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "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": "OS type id of the vm", - "name": "ostypeid", + "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", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "ssh key-pairs", - "name": "keypairs", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -64006,33 +65282,13 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "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", - "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -64040,80 +65296,25 @@ "name": "sentbytes", "type": "long" }, - { - "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, { "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "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 name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -64124,11 +65325,6 @@ "name": "value", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -64139,370 +65335,425 @@ "name": "domainpath", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the account associated with the tag", "name": "account", "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "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 user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", - "type": "integer" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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 IPv6 address of network", - "name": "ip6address", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain ID of the affinity group", + "name": "domainid", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "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" - } - ], - "since": "4.14.0" - }, - { - "description": "Creates a physical network", - "isasync": true, - "name": "createPhysicalNetwork", - "params": [ - { - "description": "the name of the physical network", - "length": 255, - "name": "name", - "required": true, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Tag the physical network", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, - { - "description": "the speed for the physical network[1G/10G]", - "length": 255, - "name": "networkspeed", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", - "length": 255, - "name": "broadcastdomainrange", - "required": false, + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "domain ID of the account owning a physical network", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", - "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the VLAN for the physical network", - "length": 255, - "name": "vlan", - "required": false, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" - } - ], - "related": "listPhysicalNetworks,updatePhysicalNetwork", - "response": [ + }, { - "description": "zone id of the physical network", - "name": "zoneid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, {}, - {}, { - "description": "comma separated tag", - "name": "tags", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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": "zone name of the physical network", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "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": "name of the physical network", - "name": "name", + "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 domain id of the physical network owner", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "the speed of the physical network", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Creates a physical network", + "isasync": true, + "name": "createPhysicalNetwork", + "params": [ + { + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "length": 255, + "name": "broadcastdomainrange", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "domain ID of the account owning a physical network", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the physical network", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" + }, + { + "description": "the speed for the physical network[1G/10G]", + "length": 255, "name": "networkspeed", + "required": false, + "type": "string" + }, + { + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "length": 255, + "name": "isolationmethods", + "required": false, + "type": "list" + } + ], + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "response": [ + { + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -64515,15 +65766,52 @@ "name": "vlan", "type": "string" }, + { + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "name of the physical network", + "name": "name", + "type": "string" + }, + { + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + }, + { + "description": "the speed of the physical network", + "name": "networkspeed", + "type": "string" + }, { "description": "state of the physical network", "name": "state", "type": "string" + }, + {}, + { + "description": "comma separated tag", + "name": "tags", + "type": "string" } ], "since": "3.0.0" @@ -64534,42 +65822,35 @@ "name": "listAutoScaleVmGroups", "params": [ { - "description": "the ID of the loadbalancer", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "name", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the profile", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -64580,24 +65861,24 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the ID of the policy", "length": 255, - "name": "page", + "name": "policyid", + "related": "listAutoScalePolicies", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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" }, @@ -64610,192 +65891,199 @@ "type": "uuid" }, { - "description": "the availability zone ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the policy", + "description": "the ID of the loadbalancer", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "string" + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "enableAutoScaleVmGroup", "response": [ - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, { "description": "the project id of the vm group", "name": "projectid", "type": "string" }, - {}, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "the 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", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public port", - "name": "publicport", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "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 name of the autoscale vm group ", - "name": "name", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, - {}, { - "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 public ip address id", - "name": "publicipid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "the private port", - "name": "privateport", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the public port", + "name": "publicport", "type": "string" }, + {}, { "description": "the current state of the AutoScale Vm Group", "name": "state", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the 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 public ip address", + "name": "publicip", "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 number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "the 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": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" } ] }, @@ -64805,16 +66093,16 @@ "name": "updatePod", "params": [ { - "description": "the gateway for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "gateway", + "name": "name", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "endip", + "name": "allocationstate", "required": false, "type": "string" }, @@ -64826,16 +66114,23 @@ "type": "string" }, { - "description": "the netmask of the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "netmask", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "name", + "name": "endip", + "required": false, + "type": "string" + }, + { + "description": "the netmask of the Pod", + "length": 255, + "name": "netmask", "required": false, "type": "string" }, @@ -64846,13 +66141,6 @@ "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" } ], "related": "createPod,listPods,createManagementNetworkIpRange", @@ -64863,58 +66151,69 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the Pod", + "name": "netmask", "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": "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 ID of the Pod", + "name": "id", + "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", "type": "list" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", "type": "list" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "description": "the allocation state of the Pod", + "name": "allocationstate", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { @@ -64928,40 +66227,40 @@ "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -64970,9 +66269,9 @@ "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 tag for the capacity type", @@ -64980,29 +66279,29 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" }, { "description": "the capacity type", @@ -65010,33 +66309,22 @@ "type": "short" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, { "description": "the name of the Pod", "name": "name", "type": "string" - }, - {}, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" } ] }, @@ -65073,569 +66361,345 @@ "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "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": "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 ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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 domain name of the security group", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 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" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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", - "response": [ - { - "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" - }, - { - "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 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "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": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "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": "device type of the root volume", - "name": "rootdevicetype", + "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", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "OS type id of the vm", + "name": "ostypeid", "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": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "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", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "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": "tag value", - "name": "value", + "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 domain associated with the tag", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, - {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "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": "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", + "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", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "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 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 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": "publicipid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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 VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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": "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": "the group ID of the virtual machine", + "name": "groupid", + "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" }, { @@ -65643,58 +66707,68 @@ "name": "nic", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -65703,63 +66777,68 @@ "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "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 IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "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 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 netmask of the nic", - "name": "netmask", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -65768,189 +66847,559 @@ "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ], "type": "set" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "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 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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "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", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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 backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "true if vm 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", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", - "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 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "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 description of the affinity group", - "name": "description", - "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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 account owning the affinity group", - "name": "account", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", + "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" } @@ -65958,28 +67407,18 @@ "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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 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": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -65988,13 +67427,8 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -66008,306 +67442,267 @@ "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + } + ] + }, + { + "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "isasync": false, + "name": "ldapRemove", + "params": [], + "related": "", + "response": [ { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "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": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "DN password", + "name": "bindpass", "type": "string" - }, + } + ], + "since": "3.0.1" + }, + { + "description": "Creates a user for an account that already exists", + "isasync": false, + "name": "createUser", + "params": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "email", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" - }, + } + ], + "related": "disableUser,getUser,listUsers,lockUser", + "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "User VM type", - "name": "vmtype", - "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 role", + "name": "rolename", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, - {} - ] - }, - { - "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", - "isasync": false, - "name": "ldapRemove", - "params": [], - "related": "", - "response": [ { - "description": "DN password", - "name": "bindpass", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "the user lastname", + "name": "lastname", "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": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "the user email address", + "name": "email", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", - "type": "string" - } - ], - "since": "3.0.1" - }, - { - "description": "Creates a user for an account that already exists", - "isasync": false, - "name": "createUser", - "params": [ - { - "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 secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", - "length": 255, + "description": "the domain ID of the user", "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": true, + "description": "the ID of the role", + "name": "roleid", "type": "string" }, + {}, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, + "description": "the account name of the user", + "name": "account", "type": "string" - } - ], - "related": "disableUser,getUser,listUsers,lockUser", - "response": [ + }, { "description": "the user state", "name": "state", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the user firstname", @@ -66315,118 +67710,81 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + } + ] + }, + { + "description": "Resets the password for the user using the token generated via forgotPassword command.", + "isasync": false, + "name": "resetPassword", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Token generated via forgotPassword command.", + "length": 255, + "name": "token", + "required": true, "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "New password in clear text (Default hashed to SHA256SALT).", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "Username", + "length": 255, + "name": "username", + "required": true, "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + } + ], + "response": [ {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - } - ] + {} + ], + "since": "4.20.0.0" }, { "description": "Creates site to site vpn local gateway", @@ -66452,14 +67810,10 @@ ], "related": "updateVpnGateway", "response": [ + {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" - }, - { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -66468,15 +67822,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, {}, - {}, { - "description": "the project name", - "name": "project", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, { @@ -66485,29 +67843,29 @@ "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project id", @@ -66515,14 +67873,14 @@ "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpn gateway ID", + "name": "id", "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" } ] }, @@ -66531,6 +67889,14 @@ "isasync": true, "name": "addResourceDetail", "params": [ + { + "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "Map of (key/value pairs)", "length": 255, @@ -66545,14 +67911,6 @@ "required": true, "type": "string" }, - { - "description": "pass false if you want this detail to be disabled for the regular user. True by default", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "resource id to create the details for", "length": 255, @@ -66562,6 +67920,7 @@ } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -66572,13 +67931,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", @@ -66591,21 +67949,6 @@ "isasync": false, "name": "listVpnUsers", "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,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.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "the username of the vpn user.", "length": 255, @@ -66628,100 +67971,115 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "The uuid of the Vpn user", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The uuid of the Vpn user", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "addVpnUser,listVpnUsers", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "addVpnUser", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" + }, {}, { "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", "name": "state", "type": "string" }, + {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the username of the vpn user", "name": "username", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "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 account of the remote access vpn", - "name": "account", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the vpn userID", + "name": "id", "type": "string" } ] @@ -66735,34 +68093,34 @@ "description": "the ID of the forwarding rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -66777,13 +68135,6 @@ "required": true, "type": "string" }, - { - "description": "Name of the userdata", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, @@ -66799,6 +68150,13 @@ "required": false, "type": "string" }, + { + "description": "Name of the userdata", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "an optional project for the userdata", "length": 255, @@ -66816,28 +68174,28 @@ } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ], "since": "4.18" }, @@ -66846,13 +68204,6 @@ "isasync": false, "name": "addRegion", "params": [ - { - "description": "Id of the Region", - "length": 255, - "name": "id", - "required": true, - "type": "integer" - }, { "description": "Name of the region", "length": 255, @@ -66866,41 +68217,48 @@ "name": "endpoint", "required": true, "type": "string" + }, + { + "description": "Id of the Region", + "length": 255, + "name": "id", + "required": true, + "type": "integer" } ], "related": "updateRegion", "response": [ { - "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 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": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, { "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the region", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the end point of the region", @@ -66915,9 +68273,9 @@ "name": "generateUsageRecords", "params": [ { - "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "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": "startdate", + "name": "enddate", "required": false, "type": "date" }, @@ -66930,15 +68288,19 @@ "type": "uuid" }, { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" } ], "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -66949,17 +68311,13 @@ "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ] }, { @@ -66975,14 +68333,6 @@ "required": false, "type": "list" }, - { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, - "since": "4.11", - "type": "string" - }, { "description": "ID of the role", "length": 255, @@ -66999,10 +68349,17 @@ "required": false, "since": "4.11", "type": "uuid" + }, + { + "description": "Rule permission, can be: allow or deny", + "length": 255, + "name": "permission", + "required": false, + "since": "4.11", + "type": "string" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -67023,7 +68380,8 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.9.0" }, @@ -67033,127 +68391,165 @@ "name": "listAccounts", "params": [ { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "accounttype", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "state", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List accounts by the Api key access value", "length": 255, - "name": "isrecursive", + "name": "apikeyaccess", "required": false, - "type": "boolean" + "since": "4.20.1.0", + "type": "string" }, { - "description": "flag to display the resource icon for accounts", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "comma separated list of account 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": "", + "description": "list account by account ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "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 accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "iscleanuprequired", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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" }, { - "description": "list account by account ID", + "description": "", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Tag for resource type to return usage", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "tag", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "list account by account name", "length": 255, - "name": "iscleanuprequired", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list account by account name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "page", + "name": "accounttype", "required": false, "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "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 tagged resource limit and count for the account", "name": "taggedresources", "type": "list" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { @@ -67161,99 +68557,129 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "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" + }, { "description": "the total number of public ip addresses this account can acquire", "name": "iplimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the account ID of the user", @@ -67261,73 +68687,87 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "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 date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ], "type": "list" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, - {}, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { "description": "the total number of vpcs owned by account", @@ -67335,13 +68775,13 @@ "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -67350,84 +68790,146 @@ "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 available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, { "description": "the total number of virtual machines deployed by this account", "name": "vmtotal", "type": "long" }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, { "description": "the total primary storage space (in GiB) owned by account", "name": "primarystoragetotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "the ID of the role", @@ -67435,269 +68937,275 @@ "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Destroys a router.", + "isasync": true, + "name": "destroyRouter", + "params": [ { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the version of template", + "name": "version", "type": "string" }, - {}, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, + {}, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - } - ] - }, - { - "description": "Destroys a router.", - "isasync": true, - "name": "destroyRouter", - "params": [ - { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "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": "the gateway for the router", - "name": "gateway", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the id of the router", + "name": "id", "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": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { @@ -67705,23 +69213,33 @@ "name": "nic", "response": [ { - "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", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -67730,43 +69248,33 @@ "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -67775,43 +69283,48 @@ "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -67820,28 +69333,28 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "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", + "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 netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -67850,51 +69363,36 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the domain associated with the router", + "name": "domain", "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 template ID for the router", - "name": "templateid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { @@ -67903,33 +69401,23 @@ "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "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 domain associated with the router", - "name": "domain", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -67937,122 +69425,15 @@ "name": "dns1", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - {}, - {}, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the first IPv6 DNS for the router", "name": "ip6dns1", "type": "string" }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, { "description": "path of the Domain the router belongs to", "name": "domainpath", "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" } ] }, @@ -68062,88 +69443,83 @@ "name": "listImageStores", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the image store provider", + "description": "the ID of the storage pool", "length": 255, - "name": "provider", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the image store protocol", + "description": "the Zone ID for the image store", "length": 255, - "name": "protocol", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the name of the image store", + "description": "read-only status of the image store", "length": 255, - "name": "name", + "name": "readonly", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "required": false, - "type": "string" + "since": "4.15.0", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the image store provider", "length": 255, - "name": "keyword", + "name": "provider", "required": false, "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "the image store protocol", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "read-only status of the image store", + "description": "the name of the image store", "length": 255, - "name": "readonly", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "name": "name", "required": false, - "since": "4.15.0", - "type": "boolean" + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", + "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 name of the image store", - "name": "name", + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -68152,44 +69528,50 @@ "type": "long" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {}, { "description": "the Zone name of the image store", "name": "zonename", "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -68197,11 +69579,10 @@ "name": "providername", "type": "string" }, - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "4.2.0" @@ -68221,27 +69602,27 @@ } ], "response": [ + {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "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" } ] }, @@ -68262,50 +69643,54 @@ "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "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 operation result", + "name": "status", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface address", + "name": "address", "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 out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "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 out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -68319,15 +69704,11 @@ "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - } + {} ], "since": "4.9.0" }, @@ -68347,29 +69728,30 @@ ], "related": "createProject", "response": [ + {}, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total 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 total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { @@ -68378,232 +69760,251 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "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 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": "tag value", - "name": "value", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "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", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "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 cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "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 state of the project", - "name": "state", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + {}, { "description": "the total number of templates which can be created by this project", "name": "templatelimit", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, { - "description": "the 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 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 domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "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 memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { @@ -68612,44 +70013,24 @@ "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" } ], "since": "3.0.0" @@ -68669,6 +70050,7 @@ } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -68680,16 +70062,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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -68699,11 +70080,11 @@ "name": "deleteAlerts", "params": [ { - "description": "delete by alert type", + "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "the IDs of the alerts", @@ -68714,11 +70095,11 @@ "type": "list" }, { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "delete by alert type", "length": 255, - "name": "startdate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -68729,6 +70110,12 @@ } ], "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", @@ -68739,17 +70126,11 @@ "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, {} ] }, @@ -68767,12 +70148,20 @@ "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "userdatadetails", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "since": "4.18.1", - "type": "map" + "type": "uuid" + }, + { + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "the time allowed for existing connections to get closed before a vm is expunged", @@ -68782,12 +70171,12 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { "description": "the ID of the Userdata", @@ -68799,49 +70188,26 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a autoscale VM profile", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "counterparam", + "name": "userdatadetails", "required": false, + "since": "4.18.1", "type": "map" }, { - "description": "an optional project for the autoscale VM profile", + "description": "account that will own the autoscale VM profile", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "domain ID of the account owning a autoscale VM profile", "length": 255, - "name": "otherdeployparams", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "map" - }, - { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, "type": "uuid" }, { @@ -68853,83 +70219,100 @@ "type": "string" }, { - "description": "account that will own the autoscale VM profile", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "an optional project for the autoscale VM profile", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "projectid", + "related": "createProject", "required": false, "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": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "type": "map" } ], "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", "response": [ { - "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 project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the 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 service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { @@ -68938,24 +70321,23 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, - {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -68964,20 +70346,19 @@ "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, - {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -68986,13 +70367,6 @@ "isasync": false, "name": "registerOauthProvider", "params": [ - { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, { "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, @@ -69001,16 +70375,16 @@ "type": "string" }, { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "description": "Description of the OAuth Provider", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "description", + "required": true, + "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", "length": 255, - "name": "redirecturi", + "name": "provider", "required": true, "type": "string" }, @@ -69022,35 +70396,42 @@ "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": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.19.0" @@ -69060,22 +70441,6 @@ "isasync": false, "name": "listLBStickinessPolicies", "params": [ - { - "description": "the ID of the load balancer stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "", "length": 255, @@ -69087,7 +70452,7 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, @@ -69104,13 +70469,34 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the ID of the load balancer stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createLBStickinessPolicy,updateLBStickinessPolicy", "response": [ { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { @@ -69123,14 +70509,14 @@ "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the params of the policy", @@ -69138,9 +70524,9 @@ "type": "map" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" }, { "description": "the method name of the Stickiness policy", @@ -69148,43 +70534,43 @@ "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the state of the policy", + "name": "state", "type": "string" } ], "type": "list" }, - {}, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, + {}, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, - {}, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the state of the policy", + "name": "state", "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 description of the Stickiness policy", - "name": "description", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { @@ -69193,13 +70579,8 @@ "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" } ], @@ -69211,10 +70592,10 @@ "name": "addUcsManager", "params": [ { - "description": "the password of UCS", + "description": "the name of UCS manager", "length": 255, - "name": "password", - "required": true, + "name": "name", + "required": false, "type": "string" }, { @@ -69226,9 +70607,9 @@ "type": "uuid" }, { - "description": "the name of UCS url", + "description": "the password of UCS", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, @@ -69240,46 +70621,46 @@ "type": "string" }, { - "description": "the name of UCS manager", + "description": "the name of UCS url", "length": 255, - "name": "name", - "required": false, + "name": "url", + "required": true, "type": "string" } ], "related": "listUcsManagers", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the zone ID of ucs manager", - "name": "zoneid", - "type": "string" - }, + {}, + {}, { "description": "the url of ucs manager", "name": "url", "type": "string" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, - {}, { "description": "the name of ucs manager", "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 ID of the ucs manager", + "name": "id", + "type": "string" } ] }, @@ -69296,14 +70677,6 @@ "since": "4.9+", "type": "boolean" }, - { - "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, @@ -69319,6 +70692,14 @@ "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" } ], "response": [ @@ -69327,22 +70708,22 @@ "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.19.0" @@ -69359,13 +70740,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -69381,6 +70755,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "netscaler load balancer device ID", "length": 255, @@ -69392,15 +70773,20 @@ ], "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ + {}, { - "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "device name", + "name": "lbdevicename", "type": "string" }, { @@ -69409,24 +70795,18 @@ "type": "long" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", + "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", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -69435,14 +70815,9 @@ "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { "description": "the private interface of the load balancer", @@ -69450,30 +70825,36 @@ "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "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": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -69494,11 +70875,12 @@ "type": "string" }, { - "description": "the name of the instance group", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { "description": "The project of the instance group", @@ -69509,25 +70891,24 @@ "type": "uuid" }, { - "description": "the domain ID of account owning the instance group", + "description": "the name of the instance group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" } ], "related": "updateInstanceGroup", "response": [ + {}, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { @@ -69536,51 +70917,51 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the ID of the instance group", - "name": "id", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the project name of the instance group", + "name": "project", "type": "string" - }, - {} + } ] }, { @@ -69588,6 +70969,13 @@ "isasync": true, "name": "createLoadBalancer", "params": [ + { + "description": "name of the load balancer", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the source port the network traffic will be load balanced from", "length": 255, @@ -69595,6 +70983,20 @@ "required": true, "type": "integer" }, + { + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "instanceport", + "required": true, + "type": "integer" + }, + { + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", + "required": false, + "type": "string" + }, { "description": "the description of the load balancer", "length": 4096, @@ -69611,18 +71013,12 @@ "type": "uuid" }, { - "description": "name of the load balancer", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "scheme", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "load balancer algorithm (source, roundrobin, leastconn)", @@ -69631,13 +71027,6 @@ "required": true, "type": "string" }, - { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" - }, { "description": "the network id of the source ip address", "length": 255, @@ -69647,88 +71036,23 @@ "type": "uuid" }, { - "description": "the source IP address the network traffic will be load balanced from", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "sourceipaddress", - "required": false, + "name": "scheme", + "required": true, "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "", "response": [ - { - "description": "the domain of the Load Balancer", - "name": "domain", - "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": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "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": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", - "type": "string" - }, { "description": "the domain ID of the Load Balancer", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { @@ -69736,13 +71060,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -69751,38 +71075,38 @@ "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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { @@ -69794,19 +71118,67 @@ "type": "list" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the state of the instance", + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", "name": "state", "type": "string" }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ { "description": "the instance ID", "name": "id", @@ -69817,6 +71189,11 @@ "name": "ipaddress", "type": "string" }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, { "description": "the name of the instance", "name": "name", @@ -69826,102 +71203,126 @@ "type": "list" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, {}, { - "description": "the 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 project name of the Load Balancer", - "name": "project", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, - {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" } ], "since": "4.2.0" }, { - "description": "Adds a Palo Alto firewall device", - "isasync": true, - "name": "addPaloAltoFirewall", + "description": "Updates a user-defined VM backup schedule", + "isasync": false, + "name": "updateBackupSchedule", "params": [ { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "Credentials to reach Palo Alto firewall device", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "username", + "name": "intervaltype", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "supports only PaloAltoFirewall", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "networkdevicetype", + "name": "timezone", "required": true, "type": "string" }, { - "description": "URL of the Palo Alto appliance.", + "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": "url", + "name": "schedule", "required": true, "type": "string" } ], - "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "related": "", "response": [ { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "domain id", + "name": "domainid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "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": "backup status", + "name": "status", + "type": "status" + }, + { + "description": "external backup id", + "name": "externalid", + "type": "string" + }, + { + "description": "backup date", + "name": "created", + "type": "date" + }, + { + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { @@ -69930,50 +71331,158 @@ "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "account id", + "name": "accountid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", + "description": "backup size in bytes", + "name": "size", + "type": "long" + }, + { + "description": "zone name", + "name": "zone", + "type": "string" + }, + { + "description": "backup type", + "name": "type", + "type": "string" + }, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "backed up volumes", + "name": "volumes", + "type": "string" + }, + { + "description": "backup offering id", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "domain name", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the VM backup", + "name": "id", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Adds a Palo Alto firewall device", + "isasync": true, + "name": "addPaloAltoFirewall", + "params": [ + { + "description": "supports only PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": true, + "type": "string" + }, + { + "description": "URL of the Palo Alto appliance.", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, "name": "username", + "required": true, "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "response": [ + { + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, + { + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, { "description": "device state", "name": "fwdevicestate", "type": "string" }, + { + "description": "name of the provider", + "name": "provider", + "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 number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + }, + { + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" + }, { "description": "the timeout (in seconds) for requests to the external firewall", "name": "timeout", "type": "string" }, {}, + {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" }, { "description": "the public security zone of the external firewall", @@ -69981,21 +71490,35 @@ "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, - {} + { + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" + } ] }, { @@ -70004,27 +71527,25 @@ "name": "createPrivateGateway", "params": [ { - "description": "the gateway of the Private gateway", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "gateway", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "The isolated network this private gateway is associated to.", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" + "name": "ipaddress", + "required": true, + "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the netmask of the Private gateway", "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" + "name": "netmask", + "required": true, + "type": "string" }, { "description": "the ID of the network ACL", @@ -70042,66 +71563,63 @@ "type": "boolean" }, { - "description": "the Physical Network ID the network belongs to", + "description": "the VPC network belongs to", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", - "required": false, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" }, { - "description": "the IP address of the Private gateaway", + "description": "the gateway of the Private gateway", "length": 255, - "name": "ipaddress", + "name": "gateway", "required": true, "type": "string" }, { - "description": "the netmask of the Private gateway", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "netmask", - "required": true, - "type": "string" + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the network implementation uri for the private gateway", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "vlan", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the VPC network belongs to", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": true, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, "type": "uuid" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" } ], "related": "createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the project name of the private gateway", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "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" }, { @@ -70110,110 +71628,115 @@ "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, - {}, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the gateway", + "name": "gateway", "type": "string" }, + {}, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ACL name set for private gateway", + "name": "aclname", + "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "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 private gateway", + "name": "projectid", + "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the zone the private gateway belongs to", "name": "zonename", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" } ], @@ -70228,12 +71751,14 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "uuid" } ], "response": [ + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -70244,7 +71769,6 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -70254,8 +71778,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -70264,20 +71787,18 @@ "name": "uploadSslCert", "params": [ { - "description": "domain ID of the account owning the SSL certificate", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for the SSL certificate", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, + "type": "string" }, { "description": "Private key", @@ -70286,13 +71807,6 @@ "required": true, "type": "string" }, - { - "description": "account that will own the SSL certificate", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Name for the uploaded certificate", "length": 255, @@ -70300,13 +71814,6 @@ "required": true, "type": "string" }, - { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", - "required": false, - "type": "string" - }, { "description": "Password for the private key", "length": 255, @@ -70315,10 +71822,10 @@ "type": "string" }, { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { @@ -70328,23 +71835,34 @@ "required": false, "since": "4.15", "type": "boolean" + }, + { + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "an optional project for the SSL certificate", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the certificate", - "name": "project", + "description": "name", + "name": "name", "type": "string" }, { @@ -70353,25 +71871,18 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "name", - "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 network owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -70384,6 +71895,13 @@ "name": "loadbalancerrulelist", "type": "list" }, + {}, + {}, + { + "description": "the project name of the certificate", + "name": "project", + "type": "string" + }, { "description": "account for the certificate", "name": "account", @@ -70394,6 +71912,11 @@ "name": "projectid", "type": "string" }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, { "description": "the domain id of the network owner", "name": "domainid", @@ -70407,16 +71930,9 @@ "name": "updateOauthProvider", "params": [ { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": false, - "type": "string" - }, - { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Description of the OAuth Provider", "length": 255, - "name": "redirecturi", + "name": "description", "required": false, "type": "string" }, @@ -70428,12 +71944,11 @@ "type": "boolean" }, { - "description": "id of the OAuth provider to be updated", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "name": "clientid", + "required": false, + "type": "string" }, { "description": "Secret Key pre-registered in the specific OAuth provider", @@ -70443,34 +71958,41 @@ "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": false, "type": "string" + }, + { + "description": "id of the OAuth provider to be updated", + "length": 255, + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, - {}, { - "description": "Name of the provider", - "name": "name", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "Name of the provider", + "name": "name", "type": "string" }, { @@ -70479,21 +72001,17 @@ "type": "boolean" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "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", @@ -70503,6 +72021,11 @@ "description": "ID of the provider", "name": "id", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -70513,84 +72036,91 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "create site-to-site VPN customer gateway for the project", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "dpd", "required": false, - "since": "4.6", - "type": "uuid" + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "esppolicy", + "name": "gateway", "required": true, "type": "string" }, { - "description": "name of this customer gateway", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "Force Encapsulation for NAT traversal", "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "create site-to-site VPN customer gateway for the project", "length": 255, - "name": "esplifetime", + "name": "projectid", + "related": "createProject", "required": false, - "type": "long" + "since": "4.6", + "type": "uuid" }, { - "description": "public ip address id of the customer gateway", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "gateway", + "name": "cidrlist", "required": true, "type": "string" }, { - "description": "Force Encapsulation for NAT traversal", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "forceencap", - "required": false, - "type": "boolean" + "name": "ipsecpsk", + "required": true, + "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "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": "dpd", + "name": "ikeversion", "required": false, - "type": "boolean" + "since": "4.15.1", + "type": "string" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "ikelifetime", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ikelifetime", + "name": "esppolicy", + "required": true, + "type": "string" + }, + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", "required": false, - "type": "long" + "type": "string" }, { "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", @@ -70608,226 +72138,139 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", - "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", - "type": "string" - }, - { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "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": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateVpnCustomerGateway", "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "if DPD is enabled for customer gateway", "name": "dpd", "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "guest ip of the customer gateway", "name": "ipaddress", "type": "string" }, - { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" - }, { "description": "Lifetime of IKE SA of customer gateway", "name": "ikelifetime", "type": "long" }, - {}, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "name of the customer gateway", - "name": "name", - "type": "string" - }, - { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" - }, - { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" - }, { "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", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - } - ] - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ - { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" - } - ], - "related": "addAnnotation,listAnnotations", - "response": [ - { - "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 type of the annotated entity", - "name": "entitytype", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, - {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" } - ], - "since": "4.11" + ] }, { "description": "add a baremetal host", @@ -70835,67 +72278,67 @@ "name": "addBaremetalHost", "params": [ { - "description": "list of tags to be added to the host", + "description": "the Pod ID for the host", "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "hypervisor type of the host", "length": 255, - "name": "ipaddress", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the cluster name for the host", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "clustername", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "hypervisor type of the host", + "description": "the host URL", "length": 255, - "name": "hypervisor", + "name": "url", "required": true, "type": "string" }, { - "description": "the cluster ID for the host", + "description": "list of tags to be added to the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hosttags", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the Pod ID for the host", + "description": "the cluster ID for the host", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "the host URL", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "url", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "username", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "the cluster name for the host", "length": 255, - "name": "password", + "name": "clustername", "required": false, "type": "string" }, @@ -70908,9 +72351,9 @@ "type": "uuid" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "password", "required": false, "type": "string" } @@ -70918,38 +72361,28 @@ "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "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 OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -70958,23 +72391,29 @@ "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "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", - "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 date and time the host was removed", - "name": "removed", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -70983,33 +72422,48 @@ "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the host version", + "name": "version", "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": "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 amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { @@ -71026,13 +72480,8 @@ "name": "vgpu", "response": [ { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -71041,18 +72490,13 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -71064,6 +72508,16 @@ "description": "Model Name of vGPU", "name": "vgputype", "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" } ], "type": "list" @@ -71072,34 +72526,34 @@ "type": "list" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "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 outgoing network traffic on the host", @@ -71107,120 +72561,109 @@ "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the Zone name of the host", + "name": "zonename", "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 Zone ID of the host", - "name": "zoneid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "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": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { "description": "the number of CPU sockets on the host", @@ -71228,19 +72671,19 @@ "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if the host supports instance conversion (using virt-v2v)", @@ -71248,25 +72691,30 @@ "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "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": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { "description": "the amount of the host's memory currently allocated in percentage", @@ -71274,41 +72722,116 @@ "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" + } + ] + }, + { + "description": "remove an annotation.", + "isasync": false, + "name": "removeAnnotation", + "params": [ + { + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "addAnnotation,listAnnotations", + "response": [ + {}, + { + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, + {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, + { + "description": "the 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 removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "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", "type": "string" } - ] + ], + "since": "4.11" }, { "description": "Disables a role", @@ -71325,6 +72848,12 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -71335,17 +72864,11 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ], "since": "4.20.0" @@ -71365,28 +72888,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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - {} + } ], "since": "4.9.0" }, @@ -71396,25 +72919,25 @@ "name": "updateVMSchedule", "params": [ { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "schedule", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "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": "enddate", + "name": "schedule", "required": false, - "type": "date" + "type": "string" }, { - "description": "Enable VM schedule", + "description": "Name of the schedule", "length": 255, - "name": "enabled", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", @@ -71424,11 +72947,11 @@ "type": "date" }, { - "description": "Name of the schedule", + "description": "Enable VM schedule", "length": 255, - "name": "description", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", @@ -71448,15 +72971,11 @@ ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Description of VM schedule", @@ -71464,29 +72983,29 @@ "type": "string" }, { - "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": "VM schedule is enabled", "name": "enabled", "type": "boolean" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, - {}, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", + "description": "Date from which the schedule is active", + "name": "startdate", "type": "date" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -71494,21 +73013,25 @@ "name": "timezone", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, { "description": "Action", "name": "action", "type": "action" - }, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" } ], "since": "4.19.0" @@ -71518,13 +73041,6 @@ "isasync": false, "name": "listConfigurationGroups", "params": [ - { - "description": "lists configuration group by group name", - "length": 255, - "name": "group", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -71539,6 +73055,13 @@ "required": false, "type": "integer" }, + { + "description": "lists configuration group by group name", + "length": 255, + "name": "group", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -71554,45 +73077,45 @@ "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 configuration group", - "name": "description", + "description": "the name of the configuration group", + "name": "name", "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 name of the configuration group", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the configuration group", + "name": "description", "type": "string" - } + }, + { + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" + }, + {}, + {} ], "since": "4.18.0" }, @@ -71610,11 +73133,6 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -71627,6 +73145,11 @@ "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", @@ -71639,6 +73162,14 @@ "isasync": true, "name": "updateRemoteAccessVpn", "params": [ + { + "description": "id of the remote access vpn", + "length": 255, + "name": "id", + "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -71654,31 +73185,13 @@ "required": false, "since": "4.4", "type": "string" - }, - { - "description": "id of the remote access vpn", - "length": 255, - "name": "id", - "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", - "required": true, - "type": "uuid" } ], "related": "createRemoteAccessVpn,listRemoteAccessVpns", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" - }, - { - "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 public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -71687,24 +73200,28 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { "description": "the public ip address of the vpn server", "name": "publicipid", "type": "string" }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, { "description": "the ipsec preshared key", "name": "presharedkey", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -71712,24 +73229,31 @@ "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", + "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 domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the range of ips to allocate to the clients", + "name": "iprange", + "type": "string" + }, + {}, + { + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { @@ -71737,10 +73261,9 @@ "name": "domain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" } ], @@ -71755,19 +73278,11 @@ "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, "name": "volumeids", - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "since": "4.12.0", "type": "list" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, { "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, @@ -71775,33 +73290,76 @@ "required": false, "since": "4.2.1", "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -71809,64 +73367,54 @@ "name": "nic", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { "description": "the isolated private VLAN type if available", @@ -71874,58 +73422,53 @@ "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "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 traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "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", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -71933,68 +73476,99 @@ "name": "ip6gateway", "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", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", - "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 isolation uri of the nic", + "name": "isolationuri", "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], "type": "set" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the 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 vGPU type used by the virtual machine", "name": "vgpu", "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": "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", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "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.", @@ -72002,123 +73576,452 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, - {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the domain name of the affinity group", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "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": "the name of the affinity group", + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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 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" + } + ], + "type": "set" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the 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 id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", @@ -72126,18 +74029,48 @@ "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -72145,30 +74078,56 @@ "name": "forvirtualnetwork", "type": "boolean" }, + {}, { - "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "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": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { "description": "the ID of the availability zone for the virtual machine", @@ -72176,144 +74135,412 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "description": "the pool type of the virtual machine", "name": "pooltype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "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" }, { - "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": "the name of the template for the virtual machine", - "name": "templatename", + "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", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + } + ] + }, + { + "description": "Assigns a VM to a backup offering", + "isasync": true, + "name": "assignVirtualMachineToBackupOffering", + "params": [ + { + "description": "ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "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.14.0" + }, + { + "description": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + }, + { + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "since": "3.0.1", + "type": "uuid" + }, + { + "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "length": 255, + "name": "considerlasthost", + "required": false, + "since": "4.18.0", + "type": "boolean" + }, + { + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "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 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 name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "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" }, { @@ -72322,198 +74549,151 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the 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": "Os type ID of the virtual machine", - "name": "guestosid", + "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", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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 high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "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": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "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 group ID of the virtual machine", - "name": "groupid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "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", + "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 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 egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -72522,32 +74702,32 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -72556,8 +74736,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -72575,163 +74755,34 @@ "name": "domainpath", "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": "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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", + "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", @@ -72743,262 +74794,55 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "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 domain ID of the security group", - "name": "domainid", + "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - } - ] - }, - { - "description": "Starts a virtual machine.", - "isasync": true, - "name": "startVirtualMachine", - "params": [ - { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "since": "3.0.1", - "type": "uuid" - }, - { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", - "length": 255, - "name": "considerlasthost", - "required": false, - "since": "4.18.0", - "type": "boolean" - }, - { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - {}, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "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 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 id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -73012,61 +74856,36 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -73074,13 +74893,8 @@ "name": "ingressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -73089,80 +74903,13 @@ "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "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 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 id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -73171,32 +74918,25 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "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 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", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -73206,24 +74946,19 @@ "name": "account", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -73232,237 +74967,160 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 project name where tag belongs to", + "name": "project", "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": "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 ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the 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 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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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 user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "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 name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "User VM type", - "name": "vmtype", + "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "the vGPU type used by the virtual machine", "name": "vgpu", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -73471,28 +75129,18 @@ "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -73501,193 +75149,115 @@ "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": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "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", @@ -73695,33 +75265,28 @@ "type": "date" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -73729,43 +75294,43 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the 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" }, { @@ -73774,81 +75339,61 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "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 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": "publicip", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -73856,43 +75401,38 @@ "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -73901,9 +75441,14 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "name of the vpc to which the nic belongs", @@ -73911,122 +75456,158 @@ "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "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 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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + {}, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "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": "publicipid", "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" } ] }, @@ -74052,28 +75633,28 @@ ], "related": "", "response": [ - {}, - {}, { "description": "id of the resource", "name": "resourceid", "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": "resource type", "name": "resourcetype", "type": "resourceobjecttype" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "base64 representation of resource icon", "name": "base64image", @@ -74088,12 +75669,27 @@ "name": "createPod", "params": [ { - "description": "the name of the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "name", - "required": true, + "name": "gateway", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this Pod for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, + { + "description": "the Zone ID in which the Pod will be created", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "the netmask for the Pod", "length": 255, @@ -74109,10 +75705,10 @@ "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "gateway", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -74121,42 +75717,73 @@ "name": "startip", "required": false, "type": "string" + } + ], + "related": "listPods,createManagementNetworkIpRange", + "response": [ + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", - "length": 255, + "description": "the ID of the Pod", + "name": "id", + "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 name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the allocation state of the Pod", "name": "allocationstate", - "required": false, "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listPods,createManagementNetworkIpRange", - "response": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "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 IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { @@ -74169,6 +75796,11 @@ "name": "cidr", "type": "string" }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, { "description": "the ending IP for the range", "name": "endip", @@ -74177,10 +75809,11 @@ ], "type": "list" }, + {}, { - "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 UUID of the latest async job acting on this object", @@ -74193,46 +75826,10 @@ "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, { "description": "the capacity of the Pod", "name": "capacity", @@ -74243,28 +75840,13 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -74273,18 +75855,13 @@ "type": "short" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -74292,35 +75869,39 @@ "name": "clustername", "type": "string" }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, { "description": "the Cluster ID", "name": "clusterid", "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], "type": "list" - }, - { - "description": "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 allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - {} + } ] }, { @@ -74337,12 +75918,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", @@ -74353,12 +75928,18 @@ "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.6.0" }, @@ -74367,6 +75948,14 @@ "isasync": true, "name": "provisionCertificate", "params": [ + { + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + }, { "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", "length": 255, @@ -74380,38 +75969,30 @@ "name": "provider", "required": false, "type": "string" - }, - { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "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" + }, {} ], "since": "4.11.0" @@ -74422,112 +76003,114 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "list by the service offering", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the group ID", "length": 255, - "name": "displayvm", + "name": "groupid", + "related": "updateInstanceGroup", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", "required": false, + "since": "4.18.0", "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": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "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": "accumulate", + "name": "details", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "list" }, { - "description": "flag to display the resource icon for VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "tags", + "name": "ids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "map" + "since": "4.4", + "type": "list" }, { - "description": "", + "description": "list vms by ssh keypair name", "length": 255, - "name": "pagesize", + "name": "keypair", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list vms by vpc", + "description": "list by network id", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "state", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "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": "createProject", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the pod ID", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "showicon", "required": false, - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { "description": "the security group ID", @@ -74539,43 +76122,49 @@ "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 availability zone ID", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list by network id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "listall", "required": false, - "since": "4.4", - "type": "list" + "type": "boolean" }, { - "description": "list vms by iso", + "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": "isoid", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the target hypervisor for the template", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -74585,100 +76174,111 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the virtual machine", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list vms by template", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "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": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" + }, + { + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the host ID", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "list by the service offering", + "description": "the cluster ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "CPU arch of the VM", "length": 255, - "name": "keypair", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "list vms by template", + "description": "the host ID", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "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": "the pod ID", "length": 255, - "name": "details", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by affinity group", "length": 255, - "name": "forvirtualnetwork", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "list vms by vpc", "length": 255, - "name": "hypervisor", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "displayvm", "required": false, + "since": "4.4", "type": "boolean" }, { @@ -74689,14 +76289,6 @@ "since": "4.18.0.0", "type": "boolean" }, - { - "description": "the group ID", - "length": 255, - "name": "groupid", - "related": "updateInstanceGroup", - "required": false, - "type": "uuid" - }, { "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, @@ -74706,146 +76298,73 @@ "type": "boolean" }, { - "description": "list by the backup offering", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "backupofferingid", + "name": "forvirtualnetwork", "required": false, - "since": "4.17", - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "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": "haenable", + "name": "accumulate", "required": false, - "since": "4.15", + "since": "4.17.0", "type": "boolean" + }, + { + "description": "the instances by userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.20.1", + "type": "uuid" } ], "related": "listVirtualMachinesMetrics", "response": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "network write in MiB", - "name": "networkwrite", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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 total cpu capacity in Ghz", - "name": "cputotal", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -74854,202 +76373,202 @@ "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "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", - "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": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the 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", + "description": "the project name of the affinity group", + "name": "project", "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", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, {}, { - "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "disk read in MiB", + "name": "diskread", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "network write in MiB", + "name": "networkwrite", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the host for the virtual machine", + "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 total memory capacity in GiB", + "name": "memorytotal", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": " an alternate display text of the template for the virtual machine", @@ -75057,8 +76576,8 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -75067,379 +76586,159 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "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 account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "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": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the state of the virtual machine", + "name": "state", "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": "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "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", - "name": "isolationuri", - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - } - ], - "type": "set" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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": "OS name of the vm", + "name": "osdisplayname", + "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "disk read in MiB", - "name": "diskread", + "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { @@ -75447,71 +76746,81 @@ "name": "securitygroup", "response": [ { - "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "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 id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -75520,69 +76829,173 @@ "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" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "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 CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "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" }, { @@ -75591,8 +77004,18 @@ "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -75600,23 +77023,23 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -75625,13 +77048,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -75640,168 +77063,161 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the group", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 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" - } - ], - "type": "set" - } - ], - "type": "set" + "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": "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" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "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 vm", + "name": "ostypeid", "type": "string" }, { @@ -75810,53 +77226,241 @@ "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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 id of userdata used for the VM", - "name": "userdataid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "disk write in MiB", + "name": "diskwrite", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "network read in MiB", + "name": "networkread", + "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": "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the 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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "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", + "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "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", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" } ] @@ -75867,68 +77471,63 @@ "name": "listHosts", "params": [ { - "description": "List by keyword", + "description": "CPU Arch of the host", "length": 255, - "name": "keyword", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "", "length": 255, - "name": "details", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the host type", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "type", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "outofbandmanagementenabled", + "name": "hahost", "required": false, "type": "boolean" }, { - "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": "resourcestate", - "required": false, - "type": "string" - }, - { - "description": "the state of the host", + "description": "the host type", "length": 255, - "name": "state", + "name": "type", "required": false, "type": "string" }, { - "description": "the Pod ID for the host", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { "description": "the Zone ID for the host", @@ -75939,25 +77538,25 @@ "type": "uuid" }, { - "description": "if true, list only hosts dedicated to HA", + "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": "hahost", + "name": "resourcestate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the host", + "description": "the state of the host", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "hypervisor", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", @@ -75967,12 +77566,18 @@ "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "the name of the host", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "the id of the host", @@ -75983,179 +77588,128 @@ "type": "uuid" }, { - "description": "lists hosts existing in particular cluster", + "description": "the Pod ID for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "declareHostAsDegraded,reconnectHost", "response": [ { - "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": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "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": "the cpu average load on the host", "name": "cpuloadaverage", "type": "double" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", "name": "memorytotal", "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "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 Pod name of the host", - "name": "podname", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "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": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "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": "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 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": "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 X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { "description": "the amount of the host's memory currently allocated in percentage", @@ -76163,14 +77717,9 @@ "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "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": "true if the host is disconnected. False otherwise.", @@ -76183,97 +77732,106 @@ "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "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": "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 amount of the host's CPU currently allocated", "name": "cpuallocated", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the host hypervisor", + "name": "hypervisor", "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": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, + {}, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, - {}, { "description": "the host HA information information", "name": "hostha", @@ -76284,20 +77842,25 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, { "description": "the IP address of the host", "name": "ipaddress", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { "description": "CPU Arch of the host", @@ -76305,84 +77868,133 @@ "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", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "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 Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" } ] }, @@ -76391,13 +78003,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, @@ -76405,20 +78010,27 @@ "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": "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", @@ -76426,9 +78038,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -76447,27 +78059,27 @@ } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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.17.0.0" @@ -76486,26 +78098,12 @@ "type": "map" }, { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "istagarule", + "name": "enabled", "required": false, "type": "boolean" }, - { - "description": "comma-separated list of tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, { "description": "Change the name of the storage pool", "length": 255, @@ -76516,19 +78114,27 @@ "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "capacityiops", + "name": "url", "required": false, - "type": "long" + "since": "4.19.0", + "type": "string" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "enabled", + "name": "istagarule", "required": false, "type": "boolean" }, + { + "description": "comma-separated list of tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "list" + }, { "description": "the Id of the storage pool", "length": 255, @@ -76538,85 +78144,85 @@ "type": "uuid" }, { - "description": "the URL of the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "url", + "name": "capacityiops", "required": false, - "since": "4.19.0", - "type": "string" + "type": "long" + }, + { + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ - {}, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "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": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { @@ -76624,51 +78230,57 @@ "name": "disksizeused", "type": "long" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the cluster for the storage pool", "name": "clusterid", "type": "string" }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { "description": "the Pod name of the storage pool", @@ -76676,34 +78288,39 @@ "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -76714,45 +78331,129 @@ "since": "3.0.0" }, { - "description": "Lists Tungsten-Fabric tags", + "description": "Lists all backup repositories", "isasync": false, - "name": "listTungstenFabricTag", + "name": "listBackupRepositories", "params": [ + { + "description": "name of the backup repository", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "ID of the backup repository", "length": 255, - "name": "taguuid", + "name": "id", + "related": "addBackupRepository,listBackupRepositories", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "ID of the zone where the backup repository is to be added", "length": 255, - "name": "vmuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "", "length": 255, - "name": "nicuuid", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the backup repository provider", "length": 255, - "name": "page", + "name": "provider", "required": false, + "type": "string" + } + ], + "related": "addBackupRepository", + "response": [ + {}, + { + "description": "the ID of the backup repository", + "name": "id", + "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 backup repository", + "name": "zoneid", + "type": "string" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" + }, + { + "description": "the name of the backup repository", + "name": "name", + "type": "string" + }, + { + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, + { + "description": "backup type", + "name": "type", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists Tungsten-Fabric tags", + "isasync": false, + "name": "listTungstenFabricTag", + "params": [ { "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, @@ -76761,12 +78462,11 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "nicuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the uuid of Tungsten-Fabric network", @@ -76775,6 +78475,20 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the uuid of Tungsten-Fabric policy", "length": 255, @@ -76782,31 +78496,54 @@ "required": false, "type": "string" }, + { + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric vm", + "length": 255, + "name": "vmuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "applyTungstenFabricTag", "response": [ { - "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 vm", + "name": "vm", + "type": "list" }, + {}, { "description": "list Tungsten-Fabric policy", "name": "policy", "type": "list" }, + { + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -76818,31 +78555,30 @@ "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, + {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, - {}, { "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" } ] }, @@ -76852,19 +78588,25 @@ "name": "importLdapUsers", "params": [ { - "description": "List by keyword", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "keyword", + "name": "timezone", "required": false, "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": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "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.", + "length": 255, + "name": "group", + "required": false, + "type": "string" }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", @@ -76874,11 +78616,11 @@ "type": "string" }, { - "description": "", + "description": "details for account used to store specific parameters", "length": 255, - "name": "page", + "name": "accountdetails", "required": false, - "type": "integer" + "type": "map" }, { "description": "Creates the account under the specified role.", @@ -76889,16 +78631,9 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "List by keyword", "length": 255, - "name": "timezone", + "name": "keyword", "required": false, "type": "string" }, @@ -76910,33 +78645,33 @@ "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": "", "length": 255, - "name": "group", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "details for account used to store specific parameters", + "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", "length": 255, - "name": "accountdetails", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" } ], "related": "searchLdap", "response": [ { - "description": "The user's domain", - "name": "domain", + "description": "The user's principle", + "name": "principal", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, - {}, { "description": "The user's email", "name": "email", @@ -76947,14 +78682,11 @@ "name": "lastname", "type": "string" }, + {}, + {}, { - "description": "The user's username", - "name": "username", - "type": "string" - }, - { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76963,8 +78695,8 @@ "type": "integer" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's username", + "name": "username", "type": "string" }, { @@ -76972,7 +78704,11 @@ "name": "firstname", "type": "string" }, - {} + { + "description": "The user's domain", + "name": "domain", + "type": "string" + } ], "since": "4.3.0" }, @@ -76982,17 +78718,17 @@ "name": "moveDomain", "params": [ { - "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" }, { - "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" @@ -77001,64 +78737,70 @@ "related": "createDomain,listDomains,listDomains", "response": [ { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", - "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": "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 networks owned by domain", + "name": "networktotal", + "type": "long" }, + {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -77066,79 +78808,79 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, - {}, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, + {}, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the path of the domain", + "name": "path", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { @@ -77147,28 +78889,18 @@ "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { @@ -77177,9 +78909,9 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "Base64 string representation of the resource icon", @@ -77187,79 +78919,83 @@ "type": "resourceiconresponse" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the name of the domain", + "name": "name", "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 the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "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 number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, - {}, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", "type": "string" } ], @@ -77271,72 +79007,62 @@ "name": "listNetworks", "params": [ { - "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": "type of the traffic", + "description": "List by keyword", "length": 255, - "name": "traffictype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list networks by ID", - "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "list networks available for VM deployment", "length": 255, - "name": "page", + "name": "canusefordeploy", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "true if network is system, false otherwise", "length": 255, - "name": "displaynetwork", + "name": "issystem", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list networks by physical network id", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "acltype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "type", + "name": "account", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list 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 networks by restartRequired", @@ -77346,56 +79072,56 @@ "type": "boolean" }, { - "description": "the network belongs to VPC", + "description": "List networks by VPC", "length": 255, - "name": "forvpc", + "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.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if network is system, false otherwise", + "description": "list networks by ID", "length": 255, - "name": "issystem", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "type of the traffic", "length": 255, - "name": "acltype", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list networks by network offering ID", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID or VID of the network", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "vlan", + "name": "displaynetwork", "required": false, - "since": "4.17.0", - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -77405,13 +79131,6 @@ "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 resources by tags (key/value pairs)", "length": 255, @@ -77420,18 +79139,19 @@ "type": "map" }, { - "description": "list networks supporting certain services", + "description": "the network belongs to VPC", "length": 255, - "name": "supportedservices", + "name": "forvpc", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "list networks by physical network id", "length": 255, - "name": "specifyipranges", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "boolean" + "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).", @@ -77442,19 +79162,35 @@ "type": "string" }, { - "description": "List networks by VPC", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "List networks by associated networks. Only available if create a Shared network.", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "list networks available for VM deployment", + "description": "the zone ID of the network", "length": 255, - "name": "canusefordeploy", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "flag to display the resource icon for networks", @@ -77464,145 +79200,129 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list networks supporting certain services", "length": 255, - "name": "keyword", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "the zone ID of the network", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "the ID or VID of the network", "length": 255, - "name": "pagesize", + "name": "vlan", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "string" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, - {}, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "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 supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "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 name of the network", - "name": "name", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, { "description": "The IPv4 routing type of network", "name": "ip4routing", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "name of the network offering the network is created from", @@ -77610,43 +79330,38 @@ "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "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": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "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": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { @@ -77655,205 +79370,103 @@ "type": "date" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "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": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "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 BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, + {}, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, { "description": "zone id of the network", "name": "zoneid", "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": "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": "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 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { "description": "the list of services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the physical network this belongs to", @@ -77871,14 +79484,19 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { "description": "uuid of the network provider", "name": "id", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -77904,43 +79522,120 @@ } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "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" + } + ], + "type": "list" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the network", + "name": "name", "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": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { @@ -77948,75 +79643,121 @@ "name": "related", "type": "string" }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, { "description": "an optional field, whether to the display the network to the end user or not.", "name": "displaynetwork", "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "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 internet protocol of network offering", - "name": "internetprotocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, { "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", "name": "cidr", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "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 network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { "description": "the name of the Network associated with this network", "name": "associatednetwork", "type": "string" + }, + {}, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" } ] }, @@ -78035,7 +79776,11 @@ } ], "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", @@ -78046,11 +79791,7 @@ "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", @@ -78066,12 +79807,11 @@ "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The new ending IP address.", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "newendip", + "required": false, + "type": "string" }, { "description": "The current starting IP address.", @@ -78081,13 +79821,6 @@ "required": true, "type": "string" }, - { - "description": "The new starting IP address.", - "length": 255, - "name": "newstartip", - "required": false, - "type": "string" - }, { "description": "The current ending IP address.", "length": 255, @@ -78097,36 +79830,44 @@ "type": "string" }, { - "description": "The new ending IP address.", + "description": "The new starting IP address.", "length": 255, - "name": "newendip", + "name": "newstartip", "required": false, "type": "string" + }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, + {}, { - "description": "the 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.16.0.0" }, @@ -78135,19 +79876,11 @@ "isasync": true, "name": "updateFirewallRule", "params": [ - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "uuid" }, @@ -78158,52 +79891,126 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the 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": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "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": "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": "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" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -78212,100 +80019,34 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "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 cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "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 ending port of firewall rule's port range", "name": "endport", "type": "integer" }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - } + {} ], "since": "4.4" }, @@ -78316,23 +80057,23 @@ "params": [], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { "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" }, @@ -78358,6 +80099,11 @@ }, {}, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -78367,11 +80113,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.19.0" @@ -78388,13 +80129,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -78408,36 +80142,38 @@ "name": "templatetype", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The quota email template locale", + "name": "locale", "type": "string" }, { - "description": "The quota email template content", - "name": "templatebody", + "description": "Template type", + "name": "templatetype", "type": "string" }, {}, - {}, { - "description": "Template type", - "name": "templatetype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The quota email template locale", - "name": "locale", - "type": "string" + "description": "Last date/time when template was updated", + "name": "last_updated", + "type": "date" }, { "description": "The quota email template subject", @@ -78445,9 +80181,14 @@ "type": "string" }, { - "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 quota email template content", + "name": "templatebody", + "type": "string" } ], "since": "4.7.0" @@ -78457,13 +80198,6 @@ "isasync": true, "name": "createBgpPeer", "params": [ - { - "description": "BGP peer details in key/value pairs.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "UUID of the zone which the Bgp Peer belongs to.", "length": 255, @@ -78473,13 +80207,20 @@ "type": "uuid" }, { - "description": "project who will own the Bgp Peer", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, + { + "description": "The password of the Bgp Peer.", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, { "description": "The AS number of the Bgp Peer.", "length": 255, @@ -78488,73 +80229,74 @@ "type": "long" }, { - "description": "The IPv4 address of the Bgp Peer.", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "ip6address", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The IPv6 address of the Bgp Peer.", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "ip6address", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "account who will own the Bgp Peer", + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" }, { - "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" } ], "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, + {}, + {}, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { @@ -78563,50 +80305,49 @@ "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "password of bgp peer", + "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": "id of the bgp peer", "name": "id", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", - "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 bgp peer", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "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": "AS number of bgp peer", "name": "asnumber", "type": "long" - }, - { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" } ], "since": "4.20.0" @@ -78632,18 +80373,18 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "Hypervisor name", "name": "name", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -78652,19 +80393,19 @@ "name": "dedicateBgpPeer", "params": [ { - "description": "account who will own the Bgp Peer", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Id of the Bgp Peer", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "id", - "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { "description": "project who will own the Bgp Peer", @@ -78675,11 +80416,11 @@ "type": "uuid" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "Id of the Bgp Peer", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, + "name": "id", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, "type": "uuid" } ], @@ -78691,45 +80432,50 @@ "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "password of bgp peer", + "name": "password", + "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, - {}, { "description": "name of zone to which the bgp peer belongs to.", "name": "zonename", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, + {}, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "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.", @@ -78737,35 +80483,30 @@ "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, + {}, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" } ], "since": "4.20.0" @@ -78776,48 +80517,41 @@ "name": "listHostsMetrics", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the name of the host", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "the id of the host", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "the Pod ID for the host", "length": 255, - "name": "details", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the host type", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "the Zone ID for the host", + "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": "zoneid", - "related": "listZones", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "uuid" + "type": "string" }, { "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", @@ -78829,7 +80563,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -78842,20 +80576,35 @@ "type": "uuid" }, { - "description": "the state of the host", + "description": "CPU Arch of the host", "length": 255, - "name": "state", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "the id of the host", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,reconnectHost", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, + { + "description": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the state of the host", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", "length": 255, @@ -78864,82 +80613,169 @@ "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": "List by keyword", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "the name of the host", "length": 255, - "name": "hahost", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the host type", + "description": "the Zone ID for the host", "length": 255, - "name": "type", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "", "length": 255, - "name": "outofbandmanagementenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the Pod ID for the host", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "hahost", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, + {}, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "network read in GiB", + "name": "networkread", + "type": "string" + }, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + {}, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "network write in GiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "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": "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": "the ID of the host", - "name": "id", + "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" }, { @@ -78948,64 +80784,79 @@ "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "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": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "instances on the host", - "name": "instances", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "system vm instances on the host", + "name": "systeminstances", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", - "type": "string" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "true if local storage is active, false otherwise", @@ -79013,63 +80864,68 @@ "type": "boolean" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the cpu average load on the host", + "description": "the average cpu load the last minute", "name": "cpuloadaverage", "type": "double" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", + "type": "string" + }, + { + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { @@ -79086,44 +80942,44 @@ "name": "vgpu", "response": [ { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "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", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum 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" } ], "type": "list" @@ -79132,39 +80988,19 @@ "type": "list" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -79172,226 +81008,139 @@ "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "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": "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 average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the name of the host", - "name": "name", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, { "description": "the amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, { "description": "the last annotation set on this host by an admin", "name": "annotation", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, { "description": "the number of CPU sockets on the host", "name": "cpusockets", "type": "integer" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", + "description": "events available for the host", + "name": "events", "type": "string" }, - {}, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "true if the host has capability to support UEFI boot", "name": "ueficapability", "type": "boolean" }, - {}, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "network read in GiB", - "name": "networkread", - "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the 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", "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" } ], "since": "4.9.3" @@ -79412,26 +81161,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "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" } ] }, @@ -79441,55 +81190,48 @@ "name": "listAffinityGroups", "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 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": "lists affinity groups by name", "length": 255, - "name": "type", + "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists affinity groups by name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "page", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "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", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -79498,6 +81240,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "lists affinity groups by virtual machine ID", "length": 255, @@ -79507,35 +81256,34 @@ "type": "uuid" }, { - "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "createAffinityGroup,listAffinityGroups", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists affinity groups by type", "length": 255, - "name": "isrecursive", + "name": "type", "required": false, - "type": "boolean" + "type": "string" } ], "related": "createAffinityGroup", "response": [ - {}, { - "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": "path of the Domain the affinity group belongs to", @@ -79543,23 +81291,30 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, + {}, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -79568,19 +81323,18 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, - {}, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -79589,19 +81343,14 @@ "type": "string" }, { - "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", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ] }, @@ -79622,36 +81371,36 @@ "related": "prepareForShutdown,readyForShutdown", "response": [ { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, - {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" }, {}, + {}, { "description": "the UUID of the latest async job acting on 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" } ], "since": "4.19.0" @@ -79662,20 +81411,12 @@ "name": "registerSSHKeyPair", "params": [ { - "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" }, - { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "createProject", - "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, @@ -79685,28 +81426,30 @@ "type": "uuid" }, { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", + "description": "Name of the keypair", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "Name of the keypair", + "description": "an optional project for the ssh key", "length": 255, - "name": "name", - "required": true, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" } ], "related": "listSSHKeyPairs", "response": [ - { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" - }, - {}, {}, { "description": "Name of the keypair", @@ -79714,8 +81457,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { @@ -79728,14 +81471,25 @@ "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 owner of the keypair", "name": "account", "type": "string" }, + {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { @@ -79744,19 +81498,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" }, { "description": "the domain id of the keypair owner", "name": "domainid", "type": "string" - }, - { - "description": "Fingerprint of the public key", - "name": "fingerprint", - "type": "string" } ] }, @@ -79773,6 +81522,20 @@ "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" + }, { "description": "the ID of the project to reserve with this IP address", "length": 255, @@ -79788,59 +81551,14 @@ "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" - }, - { - "description": "the account to reserve with this IP address", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" } ], "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ - { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" - }, - {}, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 name of the Network where ip belongs to", - "name": "networkname", + "description": "public IP address id", + "name": "id", "type": "string" }, { @@ -79849,84 +81567,39 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, { "description": "virtual machine type the ip address is assigned to", "name": "virtualmachinetype", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "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": "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 associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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 name of the Network associated with the IP address", @@ -79934,53 +81607,39 @@ "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 name the ip address is assigned to", - "name": "virtualmachinename", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { @@ -79989,57 +81648,67 @@ "type": "boolean" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" }, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -80048,17 +81717,97 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" } ], "since": "4.17" @@ -80068,13 +81817,6 @@ "isasync": false, "name": "deleteEvents", "params": [ - { - "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": "enddate", - "required": false, - "type": "date" - }, { "description": "the IDs of the events", "length": 255, @@ -80084,43 +81826,50 @@ "type": "list" }, { - "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": "string" + }, + { + "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": "enddate", "required": false, "type": "date" }, { - "description": "delete by event type", + "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" } ], "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" + } ] }, { @@ -80128,14 +81877,6 @@ "isasync": true, "name": "deleteIso", "params": [ - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, { "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", "length": 255, @@ -80143,31 +81884,39 @@ "related": "listZones", "required": false, "type": "uuid" + }, + { + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" } ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -80176,12 +81925,11 @@ "name": "listVPCOfferings", "params": [ { - "description": "list VPC offerings by id", + "description": "list VPC offerings by display text", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "true if need to list only default VPC offerings. Default value is false", @@ -80191,28 +81939,20 @@ "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "list VPC offerings by id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "since": "4.18", "type": "uuid" }, - { - "description": "list VPC offerings by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, { "description": "id of zone VPC offering is associated with", "length": 255, @@ -80223,26 +81963,35 @@ "type": "uuid" }, { - "description": "list VPC offerings by display text", + "description": "list VPC offerings by state", "length": 255, - "name": "displaytext", + "name": "state", "required": false, "type": "string" }, { - "description": "list VPC offerings by name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "list VPC offerings available for VPC creation in specific domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "since": "4.18", + "type": "uuid" + }, { "description": "list VPC offerings supporting certain services", "length": 255, @@ -80251,9 +82000,9 @@ "type": "list" }, { - "description": "List by keyword", + "description": "list VPC offerings by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" } @@ -80261,44 +82010,28 @@ "related": "updateVPCOffering", "response": [ { - "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 offering.", - "name": "displaytext", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "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", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { @@ -80306,58 +82039,42 @@ "name": "created", "type": "date" }, - { - "description": "the id of the vpc 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 vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "indicated if the offering can support region level vpc", "name": "supportsregionLevelvpc", "type": "boolean" }, + {}, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, + {}, { - "description": "the name of the vpc offering", - "name": "name", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, { "description": "the service name", "name": "name", @@ -80367,6 +82084,16 @@ "description": "the service provider name", "name": "provider", "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -80377,30 +82104,42 @@ "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": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" - }, + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" } ], "type": "list" @@ -80408,30 +82147,40 @@ ], "type": "list" }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, { "description": "true if vpc offering can be used by NSX networks only", "name": "fornsx", "type": "boolean" }, { - "description": "true if vpc offering 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 routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "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" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" } ] }, @@ -80456,6 +82205,7 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -80465,8 +82215,7 @@ "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", "name": "solidFireVolumeSize", "type": "long" - }, - {} + } ] }, { @@ -80475,10 +82224,10 @@ "name": "uploadVolume", "params": [ { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "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": "format", - "required": true, + "name": "checksum", + "required": false, "type": "string" }, { @@ -80489,6 +82238,20 @@ "required": false, "type": "uuid" }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the name of the volume", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Upload volume for the project", "length": 255, @@ -80505,18 +82268,10 @@ "type": "string" }, { - "description": "the ID of the zone the volume is to be hosted on", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "format", "required": true, - "type": "uuid" - }, - { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, "type": "string" }, { @@ -80535,115 +82290,194 @@ "type": "uuid" }, { - "description": "the name of the volume", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, + "type": "uuid" + } + ], + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "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": "checksum", - "required": false, + "description": "name of the availability zone", + "name": "zonename", "type": "string" - } - ], - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ + }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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": "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", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "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": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, { "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, + {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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" }, { @@ -80652,122 +82486,72 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "the domain associated with the disk volume", @@ -80775,164 +82559,134 @@ "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", + "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": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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": "name of the disk volume", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, { "description": "the date the volume was attached to a VM instance", "name": "attached", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "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 bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { @@ -80941,38 +82695,33 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "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 state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" } ] @@ -80983,19 +82732,19 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the ID of the host", + "description": "the host management interface password", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the ID of the host", "length": 255, - "name": "driver", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the host management interface user", @@ -81005,23 +82754,23 @@ "type": "string" }, { - "description": "the host management interface port", + "description": "the host management interface IP address", "length": 255, - "name": "port", + "name": "address", "required": true, "type": "string" }, { - "description": "the host management interface IP address", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "address", + "name": "driver", "required": true, "type": "string" }, { - "description": "the host management interface password", + "description": "the host management interface port", "length": 255, - "name": "password", + "name": "port", "required": true, "type": "string" } @@ -81029,25 +82778,18 @@ "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", "response": [ { - "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 out-of-band management action (if issued)", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the operation result", - "name": "status", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { @@ -81056,18 +82798,19 @@ "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": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, + {}, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -81076,23 +82819,29 @@ "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 action (if issued)", + "name": "action", "type": "string" }, + {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" } ], @@ -81106,14 +82855,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -81138,6 +82887,12 @@ "name": "id", "type": "string" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the pool ID of the storage tag", "name": "poolid", @@ -81147,13 +82902,7 @@ "description": "the name of the storage tag", "name": "name", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ] }, { @@ -81161,6 +82910,14 @@ "isasync": false, "name": "deleteVMSchedule", "params": [ + { + "description": "IDs of VM schedule", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" + }, { "description": "ID of VM", "length": 255, @@ -81176,37 +82933,29 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "IDs of VM schedule", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], @@ -81218,11 +82967,11 @@ "name": "createIpv4SubnetForGuestNetwork", "params": [ { - "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", + "description": "The CIDR of this Ipv4 subnet.", "length": 255, - "name": "cidrsize", + "name": "subnet", "required": false, - "type": "integer" + "type": "string" }, { "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", @@ -81233,28 +82982,18 @@ "type": "uuid" }, { - "description": "The CIDR of this Ipv4 subnet.", + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", "length": 255, - "name": "subnet", + "name": "cidrsize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "type": "string" - }, - { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" - }, - { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { @@ -81267,61 +83006,71 @@ "name": "networkid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, + {}, { - "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 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 VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "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": "state of subnet of the IPv4 network", - "name": "state", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "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" } ], @@ -81343,6 +83092,17 @@ ], "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, { "description": "the template ID", "name": "id", @@ -81353,32 +83113,21 @@ "name": "projectids", "type": "list" }, + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" - }, - {}, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" } ] }, @@ -81388,79 +83137,69 @@ "name": "listAnnotations", "params": [ { - "description": "optional: the id of the user of the annotation", + "description": "List by keyword", "length": 255, - "name": "userid", + "name": "keyword", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "", + "description": "the id of the annotation", "length": 255, - "name": "pagesize", + "name": "id", "required": false, - "type": "integer" + "type": "string" }, { - "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", + "description": "", "length": 255, - "name": "annotationfilter", + "name": "pagesize", "required": false, - "since": "4.16.0", - "type": "string" + "type": "integer" }, { - "description": "the id of the annotation", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "keyword", + "name": "entityid", "required": false, "type": "string" }, { - "description": "the entity type", + "description": "optional: the id of the user of the annotation", "length": 255, - "name": "entitytype", + "name": "userid", "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the id of the entity for which to show annotations", + "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", "length": 255, - "name": "entityid", + "name": "annotationfilter", "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "", + "description": "the entity type", "length": 255, - "name": "page", + "name": "entitytype", "required": false, - "type": "integer" + "type": "string" } ], "related": "addAnnotation", "response": [ { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { @@ -81468,20 +83207,14 @@ "name": "created", "type": "date" }, - { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" - }, - {}, { "description": "the name of the entity to which this annotation pertains", "name": "entityname", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -81489,15 +83222,31 @@ "name": "adminsonly", "type": "boolean" }, + { + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { "description": "The username of the user that entered the annotation", @@ -81505,8 +83254,8 @@ "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, {} @@ -81519,10 +83268,10 @@ "name": "addSwift", "params": [ { - "description": "the account for swift", + "description": "the URL for swift", "length": 255, - "name": "account", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -81540,86 +83289,86 @@ "type": "string" }, { - "description": "the URL for swift", + "description": "the account for swift", "length": 255, - "name": "url", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "addSecondaryStorage,listSwifts,addImageStore", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the 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 ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "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 host's currently used disk size", + "name": "disksizeused", + "type": "long" }, {}, { - "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 provider name of the image store", "name": "providername", "type": "string" - }, - {}, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" } ], "since": "3.0.0" @@ -81630,26 +83379,27 @@ "name": "listSnapshotPolicies", "params": [ { - "description": "the ID of the disk volume", + "description": "List by keyword", "length": 255, - "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the disk volume", "length": 255, - "name": "page", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "integer" + "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": "the ID of the snapshot policy", @@ -81667,38 +83417,78 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" } ], "related": "updateSnapshotPolicy", "response": [ + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + {}, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the 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 resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "tag value", + "name": "value", "type": "string" }, { @@ -81712,8 +83502,13 @@ "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", "type": "string" }, { @@ -81722,78 +83517,32 @@ "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": "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": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is this policy for display to the regular user", + "name": "fordisplay", "type": "boolean" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" } ] @@ -81804,33 +83553,47 @@ "name": "updateVpnCustomerGateway", "params": [ { - "description": "name of this customer gateway", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "name", - "required": false, + "name": "ipsecpsk", + "required": true, "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "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": "ikeversion", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", "required": false, - "since": "4.15.1", "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "ikepolicy", + "name": "cidrlist", "required": true, "type": "string" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "forceencap", + "name": "account", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" }, { "description": "id of customer gateway", @@ -81849,85 +83612,71 @@ "type": "boolean" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" - }, - { - "description": "ESP policy of the customer gateway", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "esppolicy", - "required": true, - "type": "string" + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikelifetime", + "name": "esplifetime", "required": false, "type": "long" }, { - "description": "If DPD is enabled for VPN connection", + "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": "dpd", + "name": "ikeversion", "required": false, - "type": "boolean" + "since": "4.15.1", + "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "account", - "required": false, + "name": "ikepolicy", + "required": true, "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "dpd", + "required": false, + "type": "boolean" }, { - "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": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ipsecpsk", + "name": "esppolicy", "required": true, "type": "string" - }, - { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name", - "name": "project", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { @@ -81936,9 +83685,9 @@ "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "if DPD is enabled for customer gateway", @@ -81946,55 +83695,65 @@ "type": "boolean" }, { - "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "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": "the owner", "name": "account", "type": "string" }, + { + "description": "name of the customer gateway", + "name": "name", + "type": "string" + }, {}, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, - {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -82003,39 +83762,29 @@ "type": "boolean" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -82045,25 +83794,24 @@ "name": "applyTungstenFabricTag", "params": [ { - "description": "the uuid of networks", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "networkuuid", - "required": false, - "type": "list" + "name": "taguuid", + "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" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "taguuid", - "required": true, + "name": "policyuuid", + "required": false, "type": "string" }, { @@ -82074,70 +83822,71 @@ "type": "list" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of networks", "length": 255, - "name": "applicationpolicysetuuid", + "name": "networkuuid", "required": false, - "type": "string" + "type": "list" }, { - "description": "the uuid of vms", + "description": "the ID of zone", "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of vms", "length": 255, - "name": "policyuuid", + "name": "vmuuid", "required": false, - "type": "string" + "type": "list" } ], "related": "", "response": [ - {}, - { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" - }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "list Tungsten-Fabric network", "name": "network", "type": "list" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, + {}, { "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", + "type": "string" + }, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, { "description": "list Tungsten-Fabric policy", "name": "policy", @@ -82145,9 +83894,9 @@ }, {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -82157,9 +83906,9 @@ "name": "updateObjectStoragePool", "params": [ { - "description": "the url for the object store", + "description": "the name for the object store", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, @@ -82172,9 +83921,9 @@ "type": "uuid" }, { - "description": "the name for the object store", + "description": "the url for the object store", "length": 255, - "name": "name", + "name": "url", "required": false, "type": "string" } @@ -82182,23 +83931,19 @@ "related": "addObjectStoragePool", "response": [ { - "description": "the url of the object store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" - }, - { - "description": "the provider name of the object store", - "name": "providername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "the object store currently used size", + "name": "storageused", "type": "long" }, { @@ -82207,25 +83952,29 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the url of the object store", + "name": "url", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the object store", + "name": "id", "type": "string" }, - {}, - {}, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, { "description": "the name of the object store", "name": "name", "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "description": "the provider name of the object store", + "name": "providername", "type": "string" } ], @@ -82236,13 +83985,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, @@ -82250,89 +83992,82 @@ "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 number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "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": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { "description": "the list of acl groups that account belongs to", @@ -82340,144 +84075,108 @@ "type": "list" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, + {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "the total number of virtual machines deployed by this account", "name": "vmtotal", "type": "long" }, - {}, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "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 total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, - {}, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user email address", - "name": "email", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -82486,13 +84185,28 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { @@ -82501,23 +84215,18 @@ "type": "date" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -82526,23 +84235,23 @@ "type": "integer" }, { - "description": "the user state", - "name": "state", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user ID", + "name": "id", "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" }, { @@ -82551,13 +84260,13 @@ "type": "string" }, { - "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -82566,57 +84275,82 @@ "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "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 account ID of the user", - "name": "accountid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" } ], "type": "list" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, { "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 total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { "description": "the total number of network traffic bytes received", @@ -82624,28 +84358,28 @@ "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "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", + "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { @@ -82654,24 +84388,39 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, { "description": "the name of the role", "name": "rolename", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the state of the account", @@ -82679,14 +84428,24 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" } ] }, @@ -82714,28 +84473,23 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", + "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -82743,53 +84497,53 @@ "name": "nic", "response": [ { - "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": "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 IPv6 address of network", - "name": "ip6address", - "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "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 type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { @@ -82798,38 +84552,43 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -82838,34 +84597,34 @@ "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 ip address of the nic", - "name": "ipaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "Id of the vpc to which the nic belongs", @@ -82873,118 +84632,107 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of template", + "name": "version", "type": "string" }, - {}, { - "description": "role of the domain router", - "name": "role", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the Pod name for the router", - "name": "podname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "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 state of the router", + "name": "state", + "type": "state" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the 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 template name for the router", @@ -82992,141 +84740,136 @@ "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { "description": "Last executed health check result for the router", "name": "healthcheckresults", "response": [ - { - "description": "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 date this VPC was created", - "name": "lastupdated", - "type": "date" - }, { "description": "result of the health check", "name": "success", "type": "boolean" }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, { "description": "the name of the health check on the router", "name": "checkname", "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" } ], "type": "list" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { @@ -83135,48 +84878,69 @@ "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the router", + "name": "name", "type": "string" }, + {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "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 project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" } ] @@ -83196,27 +84960,27 @@ } ], "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "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" @@ -83227,12 +84991,11 @@ "name": "createTungstenFabricFirewallPolicy", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric firewall policy name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the sequence of Tungsten-Fabric firewall policy", @@ -83249,30 +85012,30 @@ "type": "string" }, { - "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" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, {}, { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -83280,20 +85043,21 @@ "name": "zoneid", "type": "long" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" } ] }, @@ -83303,16 +85067,16 @@ "name": "updateRegion", "params": [ { - "description": "updates region with this name", + "description": "updates region with this end point", "length": 255, - "name": "name", + "name": "endpoint", "required": false, "type": "string" }, { - "description": "updates region with this end point", + "description": "updates region with this name", "length": 255, - "name": "endpoint", + "name": "name", "required": false, "type": "string" }, @@ -83326,11 +85090,6 @@ ], "related": "", "response": [ - { - "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", @@ -83341,15 +85100,16 @@ "name": "name", "type": "string" }, + {}, + {}, { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" + "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", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { @@ -83358,11 +85118,15 @@ "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" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -83380,28 +85144,28 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting 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" }, @@ -83411,19 +85175,19 @@ "name": "destroySharedFileSystem", "params": [ { - "description": "the ID of the shared filesystem to delete", + "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", "length": 255, - "name": "id", - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "name": "expunge", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", + "description": "the ID of the shared filesystem to delete", "length": 255, - "name": "expunge", + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", @@ -83434,6 +85198,7 @@ } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -83449,13 +85214,12 @@ "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" }, @@ -83489,18 +85253,13 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { @@ -83510,26 +85269,31 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the permission type of the api name or wildcard rule, allow/deny", "name": "permission", "type": "string" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.15.0" }, @@ -83539,12 +85303,11 @@ "name": "listLdapConfigurations", "params": [ { - "description": "linked domain", + "description": "Port", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "port", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -83553,6 +85316,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "Hostname", "length": 255, @@ -83561,11 +85331,12 @@ "type": "string" }, { - "description": "", + "description": "linked domain", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -83574,13 +85345,6 @@ "required": false, "type": "string" }, - { - "description": "Port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, { "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, @@ -83592,6 +85356,16 @@ ], "related": "addLdapConfiguration", "response": [ + { + "description": "linked domain", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -83603,21 +85377,11 @@ "name": "hostname", "type": "string" }, + {}, { "description": "port the ldap server is running on", "name": "port", "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "linked domain", - "name": "domainid", - "type": "string" } ], "since": "4.2.0" @@ -83635,9 +85399,17 @@ "type": "boolean" }, { - "description": "an optional account for the VPN. Must be used with domainId.", + "description": "public ip address id of the vpn server", "length": 255, - "name": "account", + "name": "publicipid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "length": 255, + "name": "iprange", "required": false, "type": "string" }, @@ -83658,36 +85430,33 @@ "type": "boolean" }, { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "description": "an optional account for the VPN. Must be used with domainId.", "length": 255, - "name": "iprange", + "name": "account", "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" } ], "related": "listRemoteAccessVpns", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "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 public ip address of the vpn server", - "name": "publicip", + "name": "publicipid", + "type": "string" + }, + { + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { @@ -83701,55 +85470,50 @@ "type": "string" }, { - "description": "is vpn 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 id of the account of the remote access vpn", - "name": "domainid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "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", "type": "string" }, + {}, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" } ] @@ -83760,20 +85524,36 @@ "name": "changeServiceForVirtualMachine", "params": [ { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "the service offering ID to apply to the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "since": "4.17", "type": "long" }, { - "description": "the service offering ID to apply to the virtual machine", + "description": "Verify OK to Shrink", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" }, { "description": "The ID of the virtual machine", @@ -83797,74 +85577,150 @@ "required": false, "since": "4.17", "type": "boolean" - }, - { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "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 format of the template for the virtual machine", - "name": "templateformat", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -83873,132 +85729,147 @@ "type": "long" }, { - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "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 description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "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": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "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", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "CPU arch of the VM", + "name": "arch", "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { "description": "the total number of network traffic bytes sent", @@ -84006,39 +85877,40 @@ "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "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": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "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 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 received", + "name": "receivedbytes", "type": "long" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "the 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", @@ -84046,198 +85918,151 @@ "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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": "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "ssh key-pairs", + "name": "keypairs", "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "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": "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", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "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 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 id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the 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", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -84246,23 +86071,23 @@ "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": "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": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -84271,44 +86096,64 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -84316,39 +86161,91 @@ "name": "virtualmachinecount", "type": "integer" }, - { - "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 ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -84356,8 +86253,8 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -84366,8 +86263,13 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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" }, { @@ -84375,485 +86277,212 @@ "name": "tags", "response": [ { - "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" }, { - "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "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": "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 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 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 list of resource tags associated with the rule", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "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": "publicipid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 vGPU type used by the virtual machine", - "name": "vgpu", + "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the nic", + "name": "id", "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the type of the nic", + "name": "type", "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": "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 traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { "description": "the gateway of IPv6 network", @@ -84861,13 +86490,18 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -84876,36 +86510,171 @@ "type": "integer" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "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": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the 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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "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" } ] @@ -84915,13 +86684,6 @@ "isasync": false, "name": "listGuestOsMapping", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list Guest OS mapping by OS mapping name with hypervisor", "length": 255, @@ -84930,17 +86692,16 @@ "type": "string" }, { - "description": "list mapping by its UUID", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "name": "hypervisorversion", "required": false, - "type": "uuid" + "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" }, @@ -84960,11 +86721,19 @@ "type": "uuid" }, { - "description": "", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "pagesize", + "name": "osdisplayname", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list mapping by its UUID", + "length": 255, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": false, + "type": "uuid" }, { "description": "", @@ -84974,33 +86743,30 @@ "type": "integer" }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", + "description": "", "length": 255, - "name": "hypervisorversion", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ + {}, + {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { @@ -85008,18 +86774,16 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "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", @@ -85029,6 +86793,11 @@ "description": "standard display name for the Guest OS", "name": "osdisplayname", "type": "string" + }, + { + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", + "type": "string" } ], "since": "4.4.0" @@ -85047,95 +86816,87 @@ "type": "boolean" }, { - "description": "the template 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": "", + "description": "the template ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "List by keyword", "length": 255, - "name": "isvnf", + "name": "keyword", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "ID of the storage pool", + "description": "ID of the image or image cache store", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, "since": "4.19", "type": "uuid" }, { - "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,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "show removed templates as well", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "showremoved", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "hypervisor", - "required": false, + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the type of the template", "length": 255, - "name": "arch", + "name": "templatetype", "required": false, - "since": "4.20", + "since": "4.19.0", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "account", + "name": "hypervisor", "required": false, "type": "string" }, { - "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 objects by project; if projectid=-1 lists All VMs", + "description": "ID of the storage pool", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "4.19", "type": "uuid" }, { @@ -85148,21 +86909,19 @@ "type": "uuid" }, { - "description": "ID of the image or image cache store", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "the template ID", + "description": "List resources by tags (key/value pairs)", "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", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "list templates by zoneId", @@ -85173,75 +86932,90 @@ "type": "uuid" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "show removed templates as well", "length": 255, - "name": "templatefilter", - "required": true, + "name": "showremoved", + "required": false, + "type": "boolean" + }, + { + "description": "the template name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "", "length": 255, - "name": "details", + "name": "pagesize", "required": false, - "since": "4.15", - "type": "list" + "type": "integer" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "page", + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "integer" + "since": "4.9", + "type": "list" }, { - "description": "flag to display the resource image for the templates", + "description": "", "length": 255, - "name": "showicon", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "listall", + "name": "isvnf", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the type of the template", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "templatetype", + "name": "details", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.15", + "type": "list" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { "description": "checksum of the template", @@ -85249,85 +87023,33 @@ "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 id of userdata linked to this template", - "name": "userdataid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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 account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { @@ -85336,69 +87058,60 @@ "type": "date" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, + {}, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "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": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "the physical size of the template", @@ -85406,170 +87119,226 @@ "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "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": "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", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "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": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "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", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the tag of this template", + "name": "templatetag", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" } ] @@ -85579,13 +87348,6 @@ "isasync": true, "name": "createTungstenFabricPolicy", "params": [ - { - "description": "Tungsten-Fabric policy name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -85593,43 +87355,50 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric policy name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listTungstenFabricPolicy", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - {}, {}, { - "description": "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": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -85652,6 +87421,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", @@ -85662,18 +87442,7 @@ "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.20.0" }, @@ -85683,12 +87452,11 @@ "name": "createBucket", "params": [ { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", + "description": "the name of the bucket", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "the account associated with the bucket. Must be used with the domainId parameter.", @@ -85697,13 +87465,6 @@ "required": false, "type": "string" }, - { - "description": "Enable bucket versioning", - "length": 255, - "name": "versioning", - "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, @@ -85713,18 +87474,26 @@ "type": "uuid" }, { - "description": "Bucket Quota in GB", + "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, - "name": "quota", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the bucket", + "description": "Enable object locking in bucket", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "objectlocking", + "required": false, + "type": "boolean" + }, + { + "description": "Bucket Quota in GB", + "length": 255, + "name": "quota", + "required": false, + "type": "integer" }, { "description": "Enable bucket encryption", @@ -85749,9 +87518,9 @@ "type": "string" }, { - "description": "Enable object locking in bucket", + "description": "Enable bucket versioning", "length": 255, - "name": "objectlocking", + "name": "versioning", "required": false, "type": "boolean" } @@ -85759,8 +87528,8 @@ "related": "listBuckets", "response": [ { - "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" }, { @@ -85769,182 +87538,182 @@ "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", + "description": "Bucket Object Locking", + "name": "objectlocking", "type": "boolean" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Object storage provider", + "name": "provider", "type": "string" }, { - "description": "Bucket URL", - "name": "url", + "description": "name of the Bucket", + "name": "name", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", + "description": "Bucket Versioning", + "name": "versioning", "type": "boolean" }, + { + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the Bucket", + "name": "state", "type": "string" }, {}, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, {}, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, - { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, { "description": "the ID of the domain associated with the bucket", "name": "domainid", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", - "type": "string" - }, - { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", - "type": "string" - }, - { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the Bucket", - "name": "account", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Bucket Quota in GB", + "name": "quota", "type": "integer" }, { - "description": "name of the Bucket", - "name": "name", - "type": "string" - }, - { - "description": "Object storage provider", - "name": "provider", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" } ], @@ -85958,79 +87727,69 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "list physical network by id", "length": 255, - "name": "keyword", + "name": "id", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "search by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Zone ID for the physical network", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list physical network by id", + "description": "the Zone ID for the physical network", "length": 255, - "name": "id", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "search by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" } ], "related": "updatePhysicalNetwork", "response": [ { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" - }, - { - "description": "name of the physical network", - "name": "name", + "description": "state of the physical network", + "name": "state", "type": "string" }, - {}, { "description": "the domain id of the physical network owner", "name": "domainid", "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", - "type": "string" - }, - { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { @@ -86039,8 +87798,8 @@ "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { @@ -86058,16 +87817,26 @@ "name": "broadcastdomainrange", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + }, + { + "description": "name of the physical network", + "name": "name", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" } ], "since": "3.0.0" @@ -86078,33 +87847,33 @@ "name": "listFirewallRules", "params": [ { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 rule with the specified ID.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -86114,34 +87883,33 @@ "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" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "tags", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "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,listDomains,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -86152,61 +87920,72 @@ "type": "uuid" }, { - "description": "list firewall rules for certain network", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "the ID of IP address of the firewall services", + "description": "list firewall rules for certain network", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.3", "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" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -86214,86 +87993,77 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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" } ], "type": "list" }, + {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "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": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { @@ -86302,25 +88072,24 @@ "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" } ] }, @@ -86340,17 +88109,12 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -86360,40 +88124,145 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Lists all Routing firewall rules", - "isasync": false, - "name": "listRoutingFirewallRules", + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "isrecursive", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Lists Routing firewall rule with the specified ID", + "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, + "name": "mode", + "required": true, + "type": "string" + }, + { + "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": false, + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, "type": "uuid" + } + ], + "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", + "response": [ + { + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "list Routing firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "type of the storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of extracted object", + "name": "id", + "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", + "type": "string" + }, + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "", + "name": "resultstring", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists all Routing firewall rules", + "isasync": false, + "name": "listRoutingFirewallRules", + "params": [ + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, "type": "boolean" }, @@ -86406,26 +88275,33 @@ "type": "uuid" }, { - "description": "list Routing firewall rules by network ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "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": "", @@ -86442,59 +88318,48 @@ "type": "map" }, { - "description": "List by keyword", + "description": "list Routing firewall rules by network ID", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list Routing firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists Routing firewall rule with the specified ID", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "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 public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - {}, - { - "description": "the 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" }, { @@ -86508,13 +88373,18 @@ "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" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -86522,8 +88392,8 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -86532,8 +88402,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -86547,18 +88422,8 @@ "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -86567,26 +88432,31 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "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 public port range", + "name": "publicport", + "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -86594,14 +88464,10 @@ "name": "networkid", "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 VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -86610,77 +88476,13 @@ "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.20.0" - }, - { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", - "params": [ - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, - { - "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 ISO is originally located", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - } - ], - "related": "downloadImageStoreObject,extractSnapshot,extractTemplate", - "response": [ - { - "description": "type of the storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", - "type": "string" - }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -86689,8 +88491,8 @@ "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 state of the rule", + "name": "state", "type": "string" }, { @@ -86698,52 +88500,19 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the extracted object", - "name": "name", - "type": "string" - }, - { - "description": "the id of extracted object", - "name": "id", - "type": "string" - }, - { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - }, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - }, - { - "description": "", - "name": "resultstring", - "type": "string" - }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the extracted object", - "name": "state", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Creates an affinity/anti-affinity group", @@ -86751,17 +88520,17 @@ "name": "createAffinityGroup", "params": [ { - "description": "an account for the affinity group. Must be used with domainId.", + "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, - "name": "account", - "required": false, + "name": "type", + "required": true, "type": "string" }, { - "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "description": "optional description of the affinity group", "length": 255, - "name": "type", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -86773,17 +88542,17 @@ "type": "uuid" }, { - "description": "name of the affinity group", + "description": "an account for the affinity group. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "optional description of the affinity group", + "description": "name of the affinity group", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -86797,12 +88566,6 @@ ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the domain name of the affinity group", "name": "domain", @@ -86814,18 +88577,19 @@ "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, + {}, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { @@ -86834,41 +88598,46 @@ "type": "integer" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {} + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } ] }, { @@ -86876,13 +88645,6 @@ "isasync": false, "name": "oauthlogin", "params": [ - { - "description": "Email id with which user tried to login using OAuth provider", - "length": 255, - "name": "email", - "required": true, - "type": "string" - }, { "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, @@ -86904,6 +88666,13 @@ "required": false, "type": "long" }, + { + "description": "Email id with which user tried to login using OAuth provider", + "length": 255, + "name": "email", + "required": true, + "type": "string" + }, { "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", "length": 255, @@ -86912,16 +88681,17 @@ "type": "string" } ], - "related": "", + "related": "samlSso", "response": [ + {}, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User ID", + "name": "userid", "type": "string" }, { @@ -86930,23 +88700,23 @@ "type": "integer" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "Username", - "name": "username", + "description": "user time zone", + "name": "timezone", "type": "string" }, { @@ -86955,56 +88725,55 @@ "type": "string" }, { - "description": "user time zone", - "name": "timezone", - "type": "string" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, + {}, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "first name of the user", + "name": "firstname", "type": "string" }, - {}, { - "description": "the account name the user belongs to", - "name": "account", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "last name of the user", - "name": "lastname", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" } ], "since": "4.19.0" @@ -87015,33 +88784,33 @@ "name": "listInternalLoadBalancerElements", "params": [ { - "description": "list internal load balancer elements by enabled state", + "description": "List by keyword", "length": 255, - "name": "enabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list internal load balancer elements by id", + "description": "list internal load balancer elements by enabled state", "length": 255, - "name": "id", - "related": "listInternalLoadBalancerElements", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list internal load balancer elements by id", "length": 255, - "name": "page", + "name": "id", + "related": "listInternalLoadBalancerElements", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list internal load balancer elements by network service provider id", @@ -87061,33 +88830,33 @@ ], "related": "", "response": [ + {}, { - "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" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the physical network service provider id of the element", "name": "nspid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, + {} ], "since": "4.2.0" }, @@ -87104,33 +88873,27 @@ "type": "string" }, { - "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" }, { - "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 guest OS count of the hypervisor", - "name": "guestoscount", + "description": "the current status of the latest async job 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 guest OS list of the hypervisor", "name": "guestoslist", @@ -87148,21 +88911,27 @@ ], "type": "list" }, + {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + }, { "description": "version of the hypervisor for guest os names", "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" } ], "since": "4.19.0" @@ -87180,91 +88949,91 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", + "description": "Tungsten-Fabric provider hostname", "length": 255, - "name": "tungstenprovidervrouterport", - "required": false, + "name": "tungstenproviderhostname", + "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric provider name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", + "description": "Tungsten-Fabric provider port", "length": 255, - "name": "tungstengateway", - "required": true, + "name": "tungstenproviderport", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider name", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "name", + "name": "tungstengateway", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", + "description": "Tungsten-Fabric provider vrouter port", "length": 255, - "name": "tungstenproviderhostname", - "required": true, + "name": "tungstenprovidervrouterport", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider port", + "description": "the ID of zone", "length": 255, - "name": "tungstenproviderport", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "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 gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { @@ -87278,56 +89047,16 @@ "type": "boolean" }, { - "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": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "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": "Tungsten-Fabric provider name", + "name": "name", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ], - "since": "4.11" + ] }, { "description": "Reboots a virtual machine.", @@ -87342,14 +89071,6 @@ "since": "4.16.0", "type": "boolean" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, { "description": "Boot into hardware setup menu or not", "length": 255, @@ -87357,34 +89078,47 @@ "required": false, "since": "4.15.0.0", "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" } ], "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 created", - "name": "created", - "type": "date" + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "the virtual network for the service offering", @@ -87392,35 +89126,111 @@ "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, - {}, - {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -87428,124 +89238,182 @@ "name": "autoscalevmgroupname", "type": "string" }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the ID of the security group", + "name": "id", "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -87554,32 +89422,32 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "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 list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -87587,57 +89455,54 @@ "name": "domainpath", "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": "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": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "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" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, + } + ], + "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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -87646,47 +89511,15 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "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 name of the security group", - "name": "name", - "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 type of the ICMP message response", "name": "icmptype", @@ -87698,8 +89531,8 @@ "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" }, { @@ -87707,63 +89540,53 @@ "name": "ruleid", "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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 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 project name where tag belongs to", - "name": "project", + "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": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -87779,16 +89602,6 @@ ], "type": "set" }, - { - "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", @@ -87798,309 +89611,189 @@ "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "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", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "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 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": "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": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "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": "the name of the affinity group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the description of the affinity group", + "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" }, + {}, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "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 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", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -88109,73 +89802,68 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 type of the nic", + "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "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": "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 gateway of IPv6 network", - "name": "ip6gateway", - "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "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 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": "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -88184,9 +89872,14 @@ "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -88194,18 +89887,18 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "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 ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -88214,27 +89907,27 @@ "type": "list" }, { - "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": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, { - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "the id of userdata used for the VM", @@ -88242,99 +89935,161 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "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", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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 high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "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 name of the service offering of the virtual machine", @@ -88342,80 +90097,79 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Guest vm Boot Type", + "name": "boottype", "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the write (IO) of disk on the VM", @@ -88423,36 +90177,56 @@ "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + } + ] + }, + { + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", + "params": [ { - "description": "the project name of the vm", - "name": "project", + "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", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "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": "true if operation is executed successfully", + "name": "success", + "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" } - ] + ], + "since": "4.11" }, { "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", @@ -88484,11 +90258,6 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "any text associated with the success or failure", @@ -88505,7 +90274,12 @@ "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.19.0" }, @@ -88514,6 +90288,13 @@ "isasync": false, "name": "listTungstenFabricLogicalRouter", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the uuid of Tungsten-Fabric network", "length": 255, @@ -88528,6 +90309,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the ID of zone", "length": 255, @@ -88537,12 +90325,67 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, + "type": "integer" + } + ], + "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 id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ] + }, + { + "description": "Lists backup offerings", + "isasync": false, + "name": "listBackupOfferings", + "params": [ + { + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -88556,40 +90399,70 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "The backup offering ID", + "length": 255, + "name": "id", + "related": "listBackupOfferings,updateBackupOffering", + "required": false, + "type": "uuid" } ], - "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", + "related": "updateBackupOffering", "response": [ {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "name for the backup offering", + "name": "name", + "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": "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": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "zone name", + "name": "zonename", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "zone ID", + "name": "zoneid", "type": "string" }, { @@ -88597,7 +90470,8 @@ "name": "jobid", "type": "string" } - ] + ], + "since": "4.14.0" }, { "description": "Adds a guest OS name to hypervisor OS name mapping", @@ -88605,12 +90479,11 @@ "name": "addGuestOsMapping", "params": [ { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "forced", - "required": false, - "since": "4.19.0", - "type": "boolean" + "name": "osnameforhypervisor", + "required": true, + "type": "string" }, { "description": "Hypervisor type. One of : XenServer, KVM, VMWare", @@ -88628,18 +90501,12 @@ "type": "uuid" }, { - "description": "OS name specific to the hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": true, - "type": "string" - }, - { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "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": "hypervisorversion", - "required": true, - "type": "string" + "name": "osmappingcheckenabled", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", @@ -88649,62 +90516,69 @@ "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": "Forces add user defined guest os mapping, overrides any existing user defined mapping", "length": 255, - "name": "osmappingcheckenabled", + "name": "forced", "required": false, "since": "4.19.0", "type": "boolean" + }, + { + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "length": 255, + "name": "hypervisorversion", + "required": true, + "type": "string" } ], "related": "updateGuestOsMapping", "response": [ { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" - }, - { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, + {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "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": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" }, - {}, { "description": "hypervisor specific name for the Guest OS", "name": "osnameforhypervisor", "type": "string" + }, + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" } ], "since": "4.4.0" @@ -88715,71 +90589,73 @@ "name": "listVnfTemplates", "params": [ { - "description": "If set to true, list only unique templates across zones", + "description": "the template name", "length": 255, - "name": "showunique", + "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.", + "length": 255, + "name": "listall", "required": false, - "since": "4.13.2", "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "show removed templates as well", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "showremoved", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list datadisk templates by parent template id", + "description": "the template ID", "length": 255, - "name": "parenttemplateid", + "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, - "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": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "list templates by zoneId", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "the template name", + "description": "the type of the template", "length": 255, - "name": "name", + "name": "templatetype", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", - "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" - }, - { - "description": "flag to display the resource image for the templates", + "description": "list templates by zoneId", "length": 255, - "name": "showicon", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -88789,19 +90665,10 @@ "type": "string" }, { - "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 CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "arch", + "name": "account", "required": false, - "since": "4.20", "type": "string" }, { @@ -88813,143 +90680,222 @@ "type": "list" }, { - "description": "list only resources belonging to the domain specified", + "description": "show removed templates as well", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "showremoved", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "isrecursive", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "hypervisor", "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": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "listall", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the type of the template", + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the template ID", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "id", + "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, + "since": "4.4", "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "hypervisor", + "name": "isvnf", "required": false, - "type": "string" + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "If set to true, list only unique templates across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "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": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + {}, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "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 name of the OS type for this template.", "name": "ostypename", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + {}, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { "description": "true if the template is ready to be deployed from, false otherwise.", @@ -88957,120 +90903,100 @@ "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "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": "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": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "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", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -89079,89 +91005,73 @@ "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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 template ID", + "name": "id", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the template", + "name": "arch", "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 account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the status of the template", - "name": "status", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the template name", - "name": "name", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the 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" }, { @@ -89170,66 +91080,30 @@ "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { "description": "Lists the download progress of a template across all secondary storages", "name": "downloaddetails", "type": "list" - }, - { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 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" - }, - {} + } ], "since": "4.19.0" }, @@ -89239,209 +91113,212 @@ "name": "deployVnfAppliance", "params": [ { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "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": "rootdisksize", + "name": "bootmode", "required": false, - "since": "4.4", - "type": "long" + "since": "4.14.0.0", + "type": "string" }, { - "description": "availability zone for the virtual machine", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "name": "displayname", "required": false, - "since": "4.12", "type": "string" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "used to specify the vApp properties.", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "properties", "required": false, - "type": "list" + "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", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", "required": false, - "type": "string" + "since": "4.13", + "type": "boolean" }, { - "description": "the ip address for default vm's network", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "availability zone for the virtual machine", "length": 255, - "name": "password", - "required": false, - "since": "4.19.0.0", - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", "length": 255, - "name": "size", + "name": "diskofferingid", + "related": "", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "hypervisor", + "name": "nicmultiqueuenumber", "required": false, - "type": "string" + "since": "4.18", + "type": "integer" }, { - "description": "an optional group for the virtual machine", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "group", + "name": "userdatadetails", "required": false, - "type": "string" + "since": "4.18", + "type": "map" }, { - "description": "host name for the virtual machine", + "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": "name", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "Deploy vm for the project", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "startvm", "required": false, - "type": "uuid" + "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 arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "customid", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "overridediskofferingid", + "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "Controls specific policies on IO", + "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": "iodriverpolicy", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "The number of queues for multiqueue NICs.", + "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": "nicmultiqueuenumber", + "name": "datadiskofferinglist", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.11", + "type": "map" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "details", "required": false, - "type": "uuid" + "since": "4.3", + "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": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "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": "deploymentplanner", + "name": "rootdisksize", "required": false, "since": "4.4", - "type": "string" + "type": "long" }, { - "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 field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "bootmode", + "name": "customid", "required": false, - "since": "4.14.0.0", "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 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": "datadiskofferinglist", + "name": "vnfcidrlist", "required": false, - "since": "4.11", - "type": "map" + "type": "list" }, { - "description": "the ID of the template for the virtual machine", + "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": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "iothreadsenabled", + "required": false, + "type": "boolean" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "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": "details", + "name": "keyboard", "required": false, - "since": "4.3", - "type": "map" + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "bootintosetup", + "name": "keypairs", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.17", + "type": "list" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "iptonetworklist", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "used to specify the vApp properties.", + "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": "properties", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, - "since": "4.15", - "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", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" }, { "description": "true if virtual machine needs to be dynamically scalable", @@ -89452,81 +91329,79 @@ "type": "boolean" }, { - "description": "an optional user generated name for the virtual machine", + "description": "the ID of the Userdata", "length": 255, - "name": "displayname", + "name": "userdataid", + "related": "", "required": false, - "type": "string" + "since": "4.18", + "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "an optional group for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "group", + "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": "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": "vnfconfiguremanagement", + "name": "boottype", "required": false, - "type": "boolean" + "since": "4.14.0.0", + "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "copyimagetags", + "name": "deploymentplanner", "required": false, - "since": "4.13", - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "displayvm", + "name": "account", "required": false, - "since": "4.2", - "type": "boolean" + "type": "string" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "the ip address for default vm's network", "length": 255, - "name": "boottype", + "name": "ipaddress", "required": false, - "since": "4.14.0.0", "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": "the ipv6 address for default vm's network", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "ip6address", "required": false, - "type": "list" + "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "displayvm", "required": false, - "type": "uuid" + "since": "4.2", + "type": "boolean" }, { - "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": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "vnfcidrlist", + "name": "keypair", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "Deploy vm for the project", "length": 255, - "name": "userdataid", - "related": "", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.18", "type": "uuid" }, { @@ -89537,274 +91412,547 @@ "type": "map" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "securitygroupids", - "related": "updateSecurityGroup", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "list" + "since": "4.18", + "type": "boolean" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "Controls specific policies on IO", "length": 255, - "name": "keypair", + "name": "iodriverpolicy", "required": false, "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" - }, - { - "description": "the mac address for default vm's network", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "macaddress", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "string" + "type": "list" }, { - "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", + "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": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "securitygroupnames", + "name": "securitygroupids", "related": "updateSecurityGroup", "required": false, "type": "list" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "iothreadsenabled", + "name": "bootintosetup", "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, - "type": "list" + "since": "4.12", + "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": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", "length": 255, - "name": "nicnetworklist", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.15", - "type": "map" + "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "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": "startvm", + "name": "vnfconfiguremanagement", "required": false, "type": "boolean" }, { - "description": "Enable packed virtqueues or not.", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "password", "required": false, - "since": "4.18", - "type": "boolean" + "since": "4.19.0.0", + "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "the mac address for default vm's network", "length": 255, - "name": "keypairs", + "name": "macaddress", "required": false, - "since": "4.17", - "type": "list" + "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": "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": "overridediskofferingid", - "related": "", + "name": "iptonetworklist", "required": false, - "since": "4.17", - "type": "uuid" + "type": "map" + }, + { + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" } ], "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the virtual machine", + "name": "name", "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 name of the vm", - "name": "osdisplayname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "publicipid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain 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 domain associated with the tag", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "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", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "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 ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "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 target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { "description": "NICs of the VNF appliance", @@ -89812,8 +91960,8 @@ "type": "list" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -89822,125 +91970,90 @@ "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "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": "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": "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": "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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -89949,18 +92062,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", @@ -89971,11 +92089,6 @@ "name": "endport", "type": "integer" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the id of the security group rule", "name": "ruleid", @@ -89986,109 +92099,27 @@ "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 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 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -90097,12 +92128,32 @@ "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -90116,549 +92167,361 @@ "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "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 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 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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "tag value", + "name": "value", "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 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", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - {}, - {}, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 type of the nic", - "name": "type", - "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": "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 name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the security group", "name": "id", "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "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": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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 id of the vm", - "name": "projectid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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 name of the virtual machine", - "name": "name", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "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": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "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 name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - } - ], - "type": "set" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "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", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { "description": "an optional field whether to the display the vm to the end user or not.", @@ -90666,68 +92529,84 @@ "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "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 group ID of the virtual machine", - "name": "groupid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" } ], @@ -90746,11 +92625,11 @@ "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "update state for the network offering", "length": 255, - "name": "maxconnections", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { "description": "the display text of the network offering", @@ -90760,31 +92639,16 @@ "type": "string" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "the id of the network offering", - "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "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": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "keepaliveenabled", + "name": "maxconnections", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the name of the network offering", - "length": 255, - "name": "name", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, @@ -90795,121 +92659,87 @@ "required": false, "type": "string" }, - { - "description": "update state for the network offering", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "sort key of the network offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - } - ], - "related": "createNetworkOffering,listNetworkOfferings", - "response": [ - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - {}, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, - { - "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": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + { + "description": "the id of the network offering", + "length": 255, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "sort key of the network offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" - }, - { - "description": "availability of the network offering", - "name": "availability", + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "createNetworkOffering,listNetworkOfferings", + "response": [ { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, { "description": "the service name", "name": "name", @@ -90920,13 +92750,8 @@ "name": "provider", "response": [ { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -90935,45 +92760,28 @@ "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 physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the provider name", + "name": "name", "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" } ], @@ -90983,23 +92791,63 @@ "type": "list" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 network offering", + "name": "id", + "type": "string" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "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", + "type": "boolean" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { @@ -91008,13 +92856,13 @@ "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "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" }, { @@ -91023,61 +92871,92 @@ "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "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" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" }, + {}, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, - { - "description": "the id of the network offering", - "name": "id", - "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": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + {}, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" }, - {} + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + } ] }, { @@ -91104,24 +92983,23 @@ "related": "enableOutOfBandManagementForHost", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "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 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 port", + "name": "port", "type": "string" }, { @@ -91135,39 +93013,40 @@ "type": "integer" }, { - "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": "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 out-of-band management driver for the host", "name": "driver", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, + {}, + {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -91179,12 +93058,18 @@ "name": "listResourceDetails", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "list 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.", @@ -91194,33 +93079,33 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list by resource type", "length": 255, - "name": "keyword", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "list by resource id", + "description": "List by keyword", "length": 255, - "name": "resourceid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "value", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -91231,32 +93116,33 @@ "type": "uuid" }, { - "description": "list by key", + "description": "", "length": 255, - "name": "key", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by resource type", + "description": "list by resource id", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "account", + "name": "value", "required": false, + "since": "4.4", "type": "string" }, { - "description": "", + "description": "list by key", "length": 255, - "name": "page", + "name": "key", "required": false, - "type": "integer" + "type": "string" }, { "description": "if set to true, only details marked with display=true, are returned. False by default", @@ -91265,36 +93151,29 @@ "required": false, "since": "4.3", "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" } ], "related": "", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "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" }, { @@ -91302,124 +93181,49 @@ "name": "domain", "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.2" - }, - { - "description": "Dedicate an existing cluster", - "isasync": true, - "name": "dedicateCluster", - "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "listDedicatedClusters", - "response": [ - { - "description": "the domain ID of the cluster", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, - {}, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "resource type", + "name": "resourcetype", "type": "string" } - ] + ], + "since": "4.2" }, { "description": "Creates a network offering.", @@ -91427,55 +93231,56 @@ "name": "createNetworkOffering", "params": [ { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "keepaliveenabled", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "services supported by the network offering", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "supportedservices", + "name": "fortungsten", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if the network offering is IP conserve mode enabled", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "conservemode", + "name": "routingmode", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "specifyipranges", + "name": "enable", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", "length": 255, - "name": "maxconnections", + "name": "serviceproviderlist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "routingmode", + "name": "ispersistent", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "description": "services supported by the network offering", "length": 255, - "name": "internetprotocol", + "name": "supportedservices", "required": false, - "since": "4.17.0", - "type": "string" + "type": "list" }, { "description": "the ID of the containing zone(s), null for public offerings", @@ -91487,68 +93292,77 @@ "type": "list" }, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, 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": "fortungsten", + "name": "internetprotocol", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "ispersistent", + "name": "maxconnections", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "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": "networkmode", + "name": "availability", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "data transfer rate in megabits per second allowed", "length": 255, - "name": "egressdefaultpolicy", + "name": "networkrate", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "desired service capabilities as part of network offering", + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", "length": 255, - "name": "servicecapabilitylist", + "name": "details", "required": false, + "since": "4.2.0", "type": "map" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "true if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "forvpc", + "name": "nsxsupportlb", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "enable", + "name": "specifyipranges", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "description": "the service offering ID used by virtual router provider", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "availability", + "name": "egressdefaultpolicy", "required": false, + "type": "boolean" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { @@ -91559,50 +93373,48 @@ "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "servicecapabilitylist", "required": false, - "type": "list" + "type": "map" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" + "name": "traffictype", + "required": true, + "type": "string" }, { - "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "nsxsupportsinternallb", + "name": "fornsx", "required": false, "since": "4.20.0", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "networkrate", + "name": "conservemode", "required": false, - "type": "integer" + "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 display text of the network offering, defaults to the value of 'name'.", + "description": "true if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "displaytext", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { "description": "true if network offering supports choosing AS number", @@ -91613,71 +93425,59 @@ "type": "boolean" }, { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "true if network offering supports vlans", "length": 255, - "name": "fornsx", + "name": "specifyvlan", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", - "length": 255, - "name": "traffictype", - "required": true, + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the name of 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": "name", - "required": true, - "type": "string" + "name": "keepaliveenabled", + "required": false, + "type": "boolean" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "serviceproviderlist", + "name": "networkmode", "required": false, - "type": "map" + "since": "4.20.0", + "type": "string" }, { - "description": "true if network offering supports vlans", + "description": "the display text of the network offering, defaults to the value of 'name'.", "length": 255, - "name": "specifyvlan", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" } ], "related": "listNetworkOfferings", "response": [ { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, + {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "availability of the network offering", + "name": "availability", + "type": "string" }, { "description": "true if network offering supports choosing AS numbers", @@ -91685,140 +93485,225 @@ "type": "boolean" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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 network offering", - "name": "tags", - "type": "string" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, + {}, { "description": "true if network offering can be used by NSX networks only", "name": "fornsx", "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" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the name of the network offering", + "name": "name", + "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "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", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "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 is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "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": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "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 public access for guest networks", - "name": "supportspublicaccess", + "name": "supportsinternallb", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "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 guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the 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": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { @@ -91827,98 +93712,92 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service 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 provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" } ], - "since": "3.0.0" + "related": "listDedicatedClusters", + "response": [ + { + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" + }, + {}, + { + "description": "the name of the cluster", + "name": "clustername", + "type": "string" + }, + { + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" + } + ] }, { "description": "Creates an IP forwarding rule", @@ -91926,25 +93805,19 @@ "name": "createIpForwardingRule", "params": [ { - "description": "the end port for the rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "the start port for the rule", + "description": "the public IP address ID of the forwarding rule, already associated via associateIp", "length": 255, - "name": "startport", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "the end port for the rule", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "endport", + "required": false, + "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", @@ -91954,12 +93827,11 @@ "type": "boolean" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "the protocol for the rule. Valid values are TCP or UDP.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", @@ -91967,120 +93839,158 @@ "name": "cidrlist", "required": false, "type": "list" + }, + { + "description": "the start port for the rule", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" } ], "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the 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 state of the rule", + "name": "state", + "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": "privateendport", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, { "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": "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag 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": "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" } ], "type": "list" }, - { - "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 VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, { "description": "the starting port of port forwarding rule's public port range", "name": "publicport", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -92088,43 +93998,12 @@ "name": "fordisplay", "type": "boolean" }, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "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 public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -92142,30 +94021,20 @@ ], "related": "listElastistorVolume", "response": [ - { - "description": "the id of the volume", - "name": "id", - "type": "string" - }, { "description": "compression", "name": "compression", "type": "string" }, + {}, { "description": "synchronization", "name": "sync", "type": "string" }, { - "description": "deduplication", - "name": "deduplication", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the volume", + "name": "id", "type": "string" }, { @@ -92174,8 +94043,8 @@ "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { @@ -92183,7 +94052,17 @@ "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "the name of the volume", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -92192,12 +94071,18 @@ "name": "quotaStatement", "params": [ { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "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": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "startdate", "required": true, - "type": "uuid" + "type": "date" + }, + { + "description": "End of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" }, { "description": "List quota usage records for the specified usage type", @@ -92207,18 +94092,19 @@ "type": "integer" }, { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": true, - "type": "string" + "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": "Optional, Account Id for which statement needs to be generated", "length": 255, - "name": "startdate", + "name": "account", "required": true, - "type": "date" + "type": "string" }, { "description": "List usage records for the specified account", @@ -92227,31 +94113,14 @@ "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, "type": "uuid" - }, - { - "description": "End of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" } ], "related": "", "response": [ { - "description": "account id", - "name": "accountid", - "type": "long" - }, - { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" - }, - { - "description": "domain id", - "name": "domain", - "type": "long" + "description": "account name", + "name": "account", + "type": "string" }, {}, { @@ -92260,13 +94129,13 @@ "type": "integer" }, { - "description": "account name", - "name": "account", + "description": "usage unit", + "name": "unit", "type": "string" }, { - "description": "usage unit", - "name": "unit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -92275,15 +94144,25 @@ "name": "name", "type": "string" }, + { + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" + }, + { + "description": "domain id", + "name": "domain", + "type": "long" + }, { "description": "usage type", "name": "type", "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "account id", + "name": "accountid", + "type": "long" } ], "since": "4.7.0" @@ -92301,14 +94180,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "id of lb stickiness policy", "length": 255, @@ -92316,78 +94187,45 @@ "related": "createLBStickinessPolicy,updateLBStickinessPolicy", "required": true, "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "createLBStickinessPolicy", "response": [ - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, { - "description": "the domain of the Stickiness 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 Stickiness policy belongs to", - "name": "zoneid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -92396,9 +94234,9 @@ "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 state of the policy", @@ -92406,13 +94244,54 @@ "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ], "type": "list" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + {}, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, {} ], "since": "4.4" @@ -92423,32 +94302,32 @@ "name": "listPods", "params": [ { - "description": "list Pods by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the pods", + "description": "", "length": 255, - "name": "showcapacities", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list pods by allocation state", + "description": "list Pods by name", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "keyword", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -92466,38 +94345,81 @@ "type": "uuid" }, { - "description": "list Pods by Zone ID", + "description": "list pods by allocation state", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list Pods by Zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createManagementNetworkIpRange", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of the Pod", + "name": "gateway", + "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 netmask of the Pod", - "name": "netmask", + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the ID of the Pod", + "name": "id", "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 capacity of the Pod", "name": "capacity", @@ -92513,23 +94435,13 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -92543,29 +94455,39 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "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 Pod ID", "name": "podid", "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" } ], "type": "list" @@ -92575,42 +94497,36 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the name of the Pod", + "name": "name", "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 allocation state of the Pod", - "name": "allocationstate", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", "type": "list" }, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "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.", @@ -92618,51 +94534,14 @@ "type": "list" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "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 gateway of the Pod", - "name": "gateway", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" } ] }, @@ -92671,13 +94550,6 @@ "isasync": true, "name": "deleteTungstenFabricAddressGroup", "params": [ - { - "description": "the uuid of Tungsten-Fabric address group", - "length": 255, - "name": "addressgroupuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -92685,30 +94557,37 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": true, + "type": "string" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "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" } ] }, @@ -92718,18 +94597,18 @@ "name": "quotaTariffList", "params": [ { - "description": "If set to true, we will list only the removed tariffs. The default is false.", + "description": "Usage type of the resource", "length": 255, - "name": "listonlyremoved", + "name": "usagetype", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The quota tariff's id.", + "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.", "length": 255, - "name": "id", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "", @@ -92739,16 +94618,9 @@ "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.", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "Usage type of the resource", + "description": "", "length": 255, - "name": "usagetype", + "name": "page", "required": false, "type": "integer" }, @@ -92768,11 +94640,12 @@ "type": "string" }, { - "description": "", + "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": "page", + "name": "enddate", "required": false, - "type": "integer" + "since": "4.18.0.0", + "type": "date" }, { "description": "The name of the quota tariff.", @@ -92783,297 +94656,156 @@ "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": "The quota tariff's id.", + "length": 255, + "name": "id", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "usageType", - "name": "usageType", - "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, - { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" - }, { "description": "the start date of the quota tariff", "name": "effectiveDate", "type": "date" }, { - "description": "usage type description", - "name": "usageTypeDescription", - "type": "string" - }, - { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" }, + {}, { "description": "activation rule of the quota tariff", "name": "activationRule", "type": "string" }, - { - "description": "description", - "name": "description", - "type": "string" - }, - { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" - }, - {}, - { - "description": "the ID of the tariff", - "name": "id", - "type": "string" - }, - { - "description": "name", - "name": "name", - "type": "string" - }, - { - "description": "usageDiscriminator", - "name": "usageDiscriminator", - "type": "string" - }, { "description": "usageUnit", "name": "usageUnit", "type": "string" }, - {}, - { - "description": "usageName", - "name": "usageName", - "type": "string" - }, { - "description": "currency", - "name": "currency", + "description": "description", + "name": "description", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.7.0" - }, - { - "description": "Stops a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "stopKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "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", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} - ] - }, - { - "description": "Lists IPv4 subnets for zone.", - "isasync": false, - "name": "listIpv4SubnetsForZone", - "params": [ - { - "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "project who which the IPv4 subnet is dedicated to", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the domain ID which the IPv4 subnet is dedicated to.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of the IPv4 subnet.", - "length": 255, - "name": "id", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": false, - "type": "uuid" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, - { - "description": "CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, - "type": "string" - } - ], - "related": "dedicateIpv4SubnetForZone", - "response": [ {}, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, - {}, { - "description": "id of the guest IPv4 subnet", + "description": "the ID of the tariff", "name": "id", "type": "string" }, - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", - "type": "string" - }, - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "currency", + "name": "currency", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" }, + { + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + } + ], + "since": "4.7.0" + }, + { + "description": "Stops a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "stopKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account of the IPv4 subnet", - "name": "account", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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": "guest IPv4 subnet", - "name": "subnet", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } - ], - "since": "4.20.0" + }, + {}, + {} + ] }, { "description": "Adds account to a project", "isasync": true, "name": "addAccountToProject", "params": [ - { - "description": "name of the account to be added to the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "ID of the project to add the account to", "length": 255, @@ -93082,13 +94814,6 @@ "required": true, "type": "uuid" }, - { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", - "length": 255, - "name": "roletype", - "required": false, - "type": "string" - }, { "description": "email to which invitation to the project is going to be sent", "length": 255, @@ -93103,6 +94828,20 @@ "related": "listProjectRoles,updateProjectRole", "required": false, "type": "uuid" + }, + { + "description": "name of the account to be added to the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" } ], "response": [ @@ -93112,21 +94851,21 @@ "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "3.0.0" @@ -93136,13 +94875,6 @@ "isasync": false, "name": "listSnapshots", "params": [ - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "ID of the image or image cache store", "length": 255, @@ -93160,49 +94892,63 @@ "type": "integer" }, { - "description": "list snapshots by zone id", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "locationtype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "lists snapshot by snapshot ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "tags", + "required": false, + "type": "map" + }, + { + "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": "valid values are MANUAL or RECURRING.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "snapshottype", + "name": "intervaltype", "required": false, "type": "string" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "lists snapshot by snapshot ID", + "length": 255, + "name": "id", "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "since": "4.9", - "type": "list" + "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": "createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "intervaltype", + "name": "account", "required": false, "type": "string" }, @@ -93214,65 +94960,58 @@ "type": "boolean" }, { - "description": "lists snapshot by snapshot name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "list snapshots by zone id", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "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": "If set to false, list templates across zones and their storages", "length": 255, - "name": "isrecursive", + "name": "showunique", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the ID of the disk volume", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "snapshottype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of the storage pool", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "since": "4.19", - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "If set to false, list templates across zones and their storages", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "showunique", + "name": "name", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -93282,75 +95021,34 @@ "type": "string" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "the ID of the disk volume", "length": 255, - "name": "locationtype", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { @@ -93364,8 +95062,8 @@ "type": "boolean" }, { - "description": "name of the snapshot", - "name": "name", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { @@ -93374,38 +95072,40 @@ "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, + {}, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, + {}, { - "description": "name of the disk volume", - "name": "volumename", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "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 status of the template", + "name": "status", + "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { @@ -93413,33 +95113,28 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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 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" }, { @@ -93448,13 +95143,13 @@ "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -93463,22 +95158,36 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, - {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "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": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { @@ -93486,19 +95195,54 @@ "name": "state", "type": "state" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, { "description": "the project id of the snapshot", "name": "projectid", "type": "string" }, + { + "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the type of the snapshot", "name": "snapshottype", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -93507,8 +95251,100 @@ "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", + "params": [ + { + "description": "project who which the IPv4 subnet is dedicated to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the domain ID which the IPv4 subnet is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": false, + "type": "uuid" + } + ], + "related": "dedicateIpv4SubnetForZone", + "response": [ + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { @@ -93517,11 +95353,54 @@ "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + {}, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "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" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "migrates resources from one secondary storage to destination image store", @@ -93529,28 +95408,20 @@ "name": "migrateResourceToAnotherSecondaryStorage", "params": [ { - "description": "id(s) of the snapshots to be migrated", - "length": 255, - "name": "snapshots", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", - "required": false, - "type": "list" - }, - { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "destpool", + "name": "srcpool", "related": "addSecondaryStorage,listSwifts,addImageStore", "required": true, "type": "uuid" }, { - "description": "id of the image store from where the data is to be migrated", + "description": "id(s) of the snapshots to be migrated", "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": true, - "type": "uuid" + "name": "snapshots", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "required": false, + "type": "list" }, { "description": "id(s) of the templates to be migrated", @@ -93559,11 +95430,23 @@ "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 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" } ], "related": "migrateSecondaryStorageData", "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", @@ -93574,22 +95457,18 @@ "name": "message", "type": "string" }, + { + "description": "Type of migration requested for", + "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": "Type of migration requested for", - "name": "migrationtype", - "type": "string" - } + {} ], "since": "4.19.0" }, @@ -93607,11 +95486,12 @@ "type": "uuid" }, { - "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "description": "the domain ID associated with the keypair", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Name of the keypair", @@ -93621,36 +95501,35 @@ "type": "string" }, { - "description": "the domain ID associated with the keypair", + "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -93659,13 +95538,6 @@ "isasync": false, "name": "searchLdap", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -93680,6 +95552,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "query to search using", "length": 255, @@ -93692,13 +95571,8 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The user's email", - "name": "email", + "description": "The user's username", + "name": "username", "type": "string" }, { @@ -93707,37 +95581,42 @@ "type": "integer" }, {}, + { + "description": "The user's firstname", + "name": "firstname", + "type": "string" + }, { "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", "name": "conflictingusersource", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's principle", + "name": "principal", "type": "string" }, - {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "The user's domain", + "name": "domain", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's email", + "name": "email", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -93757,27 +95636,27 @@ ], "related": "prepareForShutdown", "response": [ - {}, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, {}, { "description": "Indicates whether a shutdown has been triggered", @@ -93797,13 +95676,6 @@ "isasync": true, "name": "createTungstenFabricLogicalRouter", "params": [ - { - "description": "Tungsten-Fabric logical router name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -93811,20 +95683,39 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric logical router name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "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 logical router name", "name": "name", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -93835,23 +95726,11 @@ "name": "uuid", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {} + } ] }, { @@ -93870,13 +95749,145 @@ ], "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + {}, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + {}, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -93885,64 +95896,49 @@ "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": "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 name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "public IP address id associated with this nic via Static nat rule", @@ -93950,9 +95946,9 @@ "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 ID of the corresponding network", @@ -93960,18 +95956,18 @@ "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": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -93980,38 +95976,43 @@ "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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", + "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -94020,22 +96021,31 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" } ], "type": "list" }, - {}, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { @@ -94043,180 +96053,39 @@ "name": "domainpath", "type": "string" }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "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": "service offering ID for the shared filesystem", "name": "serviceofferingid", "type": "string" }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - {}, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, { "description": "the shared filesystem's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "ID of the shared filesystem", - "name": "id", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { @@ -94224,28 +96093,28 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -94254,56 +96123,66 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" } ], @@ -94315,54 +96194,53 @@ "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "tagtypeuuid", + "name": "srcnetworkuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "desttaguuid", + "name": "srcaddressgroupuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "destaddressgroupuuid", - "required": false, + "name": "direction", + "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "destnetworkuuid", + "name": "destaddressgroupuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "srcaddressgroupuuid", - "required": false, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "name": "desttaguuid", + "required": false, + "type": "string" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "destnetworkuuid", + "required": false, + "type": "string" }, { "description": "Tungsten-Fabric firewall rule source tag uuid", @@ -94379,124 +96257,125 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "servicegroupuuid", + "name": "name", "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric source network", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "srcnetworkuuid", - "required": false, + "name": "action", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", + "description": "the ID of zone", "length": 255, - "name": "direction", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "action", + "name": "sequence", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "name", - "required": true, + "name": "tagtypeuuid", + "required": false, "type": "string" } ], "related": "listTungstenFabricFirewallRule", "response": [ { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "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 source tag", - "name": "srctag", + "description": "the UUID of the latest async job acting on 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 firewall rule destination tag", + "name": "desttag", + "type": "string" + }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", + "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, {}, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -94506,63 +96385,56 @@ "name": "listConfigurations", "params": [ { - "description": "List by keyword", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists configurations by category", + "description": "List by keyword", "length": 255, - "name": "category", + "name": "keyword", "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,listSwifts,addImageStore", - "required": false, - "type": "uuid" - }, - { - "description": "lists configuration by subgroup name (primarily used for UI)", + "description": "lists configuration by parent name (primarily used for UI)", "length": 255, - "name": "subgroup", + "name": "parent", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "", + "description": "lists configuration by group name (primarily used for UI)", "length": 255, - "name": "page", + "name": "group", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, "type": "uuid" }, { - "description": "lists configuration by parent name (primarily used for UI)", + "description": "", "length": 255, - "name": "parent", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, "type": "uuid" }, @@ -94574,6 +96446,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, @@ -94590,117 +96469,117 @@ "type": "string" }, { - "description": "lists configuration by group name (primarily used for UI)", + "description": "lists configurations by category", "length": 255, - "name": "group", + "name": "category", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "lists configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "name": "subgroup", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" } ], "related": "", "response": [ { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the description of the configuration", + "name": "description", "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": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the type of the configuration value", + "name": "type", + "type": "string" }, {}, { - "description": "the component of the configuration", - "name": "component", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "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 category of the configuration", + "name": "category", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the group of the configuration", + "name": "group", "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", + "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", - "type": "string" + "description": "the value of the configuration", + "name": "id", + "type": "long" } ] }, @@ -94709,13 +96588,6 @@ "isasync": true, "name": "scaleKubernetesCluster", "params": [ - { - "description": "Maximum number of worker nodes in the cluster", - "length": 255, - "name": "maxsize", - "required": false, - "type": "long" - }, { "description": "the IDs of the nodes to be removed", "length": 255, @@ -94725,11 +96597,11 @@ "type": "list" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, "type": "uuid" }, { @@ -94740,48 +96612,55 @@ "type": "long" }, { - "description": "number of Kubernetes cluster nodes", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "size", + "name": "autoscalingenabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "autoscalingenabled", + "name": "maxsize", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "size", "required": false, + "type": "long" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, "type": "uuid" } ], "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { @@ -94790,29 +96669,19 @@ "type": "long" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { "description": "Minimum size of the cluster", @@ -94820,105 +96689,101 @@ "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 date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, + {}, { "description": "the account associated with the Kubernetes cluster", "name": "account", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "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": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, + {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, - {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the state of the Kubernetes cluster", + "name": "state", "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": "the current status of the latest async job acting on this object", @@ -94926,35 +96791,49 @@ "type": "integer" }, { - "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 ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "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": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" } ] }, @@ -94982,13 +96861,39 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "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 link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -94997,38 +96902,38 @@ "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -95036,162 +96941,160 @@ "name": "state", "type": "state" }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, { "description": "the Pod name for the router", "name": "podname", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "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 link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, - {}, { "description": "the first DNS for the router", "name": "dns1", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "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 hostname for the router", + "name": "hostname", + "type": "string" + }, + {}, { "description": "the domain associated with the router", "name": "domain", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { @@ -95199,8 +97102,8 @@ "name": "nic", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -95209,33 +97112,28 @@ "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -95244,48 +97142,48 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -95294,158 +97192,144 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { "description": "the name of VPC the router belongs to", "name": "vpcname", "type": "string" - }, - {}, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" } ] }, @@ -95471,21 +97355,21 @@ }, {}, { - "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": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -95494,19 +97378,18 @@ "name": "updateTrafficType", "params": [ { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "ovm3networklabel", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "traffic type id", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "name": "kvmnetworklabel", + "required": false, + "type": "string" }, { "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", @@ -95516,23 +97399,24 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "vmwarenetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "traffic type id", "length": 255, - "name": "xennetworklabel", - "required": false, - "type": "string" + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "kvmnetworklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" } @@ -95540,29 +97424,28 @@ "related": "addTrafficType", "response": [ { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "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": "id of the network provider", + "name": "id", "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 HyperV host", - "name": "hypervnetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, { @@ -95571,23 +97454,24 @@ "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": "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" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, {} @@ -95600,17 +97484,10 @@ "name": "listConditions", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the policy", + "description": "Counter-id of the condition.", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "counterid", + "related": "createCounter", "required": false, "type": "uuid" }, @@ -95622,20 +97499,6 @@ "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.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "ID of the Condition.", "length": 255, @@ -95645,18 +97508,18 @@ "type": "uuid" }, { - "description": "Counter-id of the condition.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "counterid", - "related": "createCounter", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the policy", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, "type": "uuid" }, @@ -95667,6 +97530,27 @@ "required": false, "type": "integer" }, + { + "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, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -95675,9 +97559,9 @@ "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" } @@ -95685,13 +97569,34 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the owner of the Condition.", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the Condition.", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the project name of the Condition", + "name": "project", + "type": "string" + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -95700,8 +97605,23 @@ "type": "integer" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the Id of the Counter.", + "name": "counterid", + "type": "string" + }, + { + "description": "the id of the Condition", + "name": "id", + "type": "string" + }, + { + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" + }, + { + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, { @@ -95710,9 +97630,9 @@ "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "the domain id of the Condition owner", + "name": "domainid", + "type": "string" }, {}, { @@ -95721,47 +97641,129 @@ "type": "long" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the domain name of the owner.", + "name": "domain", + "type": "string" + } + ] + }, + { + "description": "Adds a backup repository to store NAS backups", + "isasync": false, + "name": "addBackupRepository", + "params": [ + { + "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", + "length": 255, + "name": "type", + "required": true, "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "backup repository provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "ID of the zone where the backup repository is to be added", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "capacity of this backup repository", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, + { + "description": "shared storage mount options", + "length": 255, + "name": "mountopts", + "required": false, "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "address of the backup repository", + "length": 255, + "name": "address", + "required": true, "type": "string" }, + { + "description": "name of the backup repository", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ {}, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the Zone name of the backup repository", + "name": "zonename", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "the id of the Condition", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" + }, + { + "description": "the ID of the backup repository", "name": "id", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "the name of the backup repository", + "name": "name", + "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", + "type": "string" + }, + { + "description": "the Zone ID of the backup repository", + "name": "zoneid", "type": "string" + }, + { + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, + { + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" } - ] + ], + "since": "4.20.0" }, { "description": "migrates data objects from one secondary storage to destination image store(s)", @@ -95776,13 +97778,6 @@ "required": true, "type": "list" }, - { - "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", - "length": 255, - "name": "migrationtype", - "required": false, - "type": "string" - }, { "description": "id of the image store from where the data is to be migrated", "length": 255, @@ -95790,22 +97785,28 @@ "related": "addSecondaryStorage,listSwifts,addImageStore", "required": true, "type": "uuid" + }, + { + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "length": 255, + "name": "migrationtype", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Response message from migration of secondary storage data objects", "name": "message", "type": "string" }, {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Type of migration requested for", "name": "migrationtype", @@ -95816,6 +97817,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -95829,6 +97831,14 @@ "isasync": true, "name": "destroyVolume", "params": [ + { + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + }, { "description": "If true is passed, the volume is expunged immediately. False by default.", "length": 255, @@ -95836,91 +97846,84 @@ "required": false, "since": "4.6.0", "type": "boolean" - }, - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, + {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "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": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -95929,49 +97932,48 @@ "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "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": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, - {}, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "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" }, { @@ -95980,114 +97982,94 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "the account associated with the disk volume", - "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, + {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { @@ -96095,8 +98077,8 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -96105,86 +98087,106 @@ "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, { "description": "details for the volume check result, they may vary for different hypervisors", "name": "volumecheckresult", "type": "map" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the availability zone", + "name": "zoneid", "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" }, { @@ -96193,39 +98195,44 @@ "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { "description": "the project name of the vpn", @@ -96233,28 +98240,18 @@ "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -96263,13 +98260,18 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" } ], @@ -96281,23 +98283,16 @@ "name": "addTrafficType", "params": [ { - "description": "the trafficType to be added to the physical network", - "length": 255, - "name": "traffictype", - "required": true, - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "xennetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "ovm3networklabel", + "name": "vlan", "required": false, "type": "string" }, @@ -96310,37 +98305,44 @@ "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "kvmnetworklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", "length": 255, - "name": "vmwarenetworklabel", + "name": "isolationmethod", "required": false, "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "vlan", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "isolationmethod", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "hypervnetworklabel", + "name": "traffictype", + "required": true, + "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" } @@ -96348,29 +98350,24 @@ "related": "", "response": [ { - "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", "type": "string" }, - {}, - { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", - "type": "string" - }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { @@ -96383,20 +98380,25 @@ "name": "vmwarenetworklabel", "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", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, {}, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -96408,9 +98410,9 @@ "name": "listSecondaryStorageSelectors", "params": [ { - "description": "List by keyword", + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, @@ -96421,6 +98423,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "The zone ID to be used in the search filter.", "length": 255, @@ -96430,80 +98439,73 @@ "type": "uuid" }, { - "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": "", + "description": "Show removed heuristics.", "length": 255, - "name": "pagesize", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Show removed heuristics.", + "description": "List by keyword", "length": 255, - "name": "showremoved", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", - "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": "When the heuristic was created.", + "name": "created", + "type": "date" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "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 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": "The zone which the heuristic is valid upon.", "name": "zoneid", "type": "string" }, - { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - }, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, {}, { "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.0" @@ -96513,13 +98515,6 @@ "isasync": false, "name": "listLoadBalancerRuleInstances", "params": [ - { - "description": "true if load balancer rule VM IP information to be included; default is false", - "length": 255, - "name": "lbvmips", - "required": false, - "type": "boolean" - }, { "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, @@ -96534,6 +98529,20 @@ "required": false, "type": "integer" }, + { + "description": "true if load balancer rule VM IP information to be included; default is false", + "length": 255, + "name": "lbvmips", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -96548,38 +98557,31 @@ "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "listLoadBalancerRuleInstances", "response": [ - {}, {}, - { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" }, { "description": "IP addresses of the vm set of lb rule", "name": "lbvmipaddresses", "type": "list" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -96598,16 +98600,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": "any text associated with the success or failure", "name": "displaytext", @@ -96619,6 +98611,16 @@ "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" } ] }, @@ -96628,9 +98630,17 @@ "name": "updatePhysicalNetwork", "params": [ { - "description": "Enabled/Disabled", + "description": "physical network id", "length": 255, - "name": "state", + "name": "id", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", "required": false, "type": "string" }, @@ -96641,14 +98651,6 @@ "required": false, "type": "string" }, - { - "description": "physical network id", - "length": 255, - "name": "id", - "related": "updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "Tag the physical network", "length": 255, @@ -96657,33 +98659,28 @@ "type": "list" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "Enabled/Disabled", "length": 255, - "name": "networkspeed", + "name": "state", "required": false, "type": "string" } ], "related": "", "response": [ - { - "description": "comma separated tag", - "name": "tags", - "type": "string" - }, { "description": "the vlan of the physical network", "name": "vlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the speed of the physical network", + "name": "networkspeed", + "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "name of the physical network", + "name": "name", "type": "string" }, { @@ -96692,8 +98689,8 @@ "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "comma separated tag", + "name": "tags", "type": "string" }, {}, @@ -96703,16 +98700,21 @@ "type": "string" }, { - "description": "zone id of the physical network", - "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 physical network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + { + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, { "description": "state of the physical network", "name": "state", @@ -96724,13 +98726,13 @@ "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "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" } ], @@ -96760,100 +98762,38 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag 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" - } - ], - "type": "set" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { @@ -96862,152 +98802,109 @@ "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "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": "name of the storage fs data volume", "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, + {}, { "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": "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": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "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" }, { @@ -97016,97 +98913,131 @@ "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": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 ID of the nic", - "name": "id", - "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" } ], "type": "list" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { @@ -97120,80 +99051,151 @@ "type": "long" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the storage fs vm", + "name": "vmstate", "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": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" } ], "since": "4.20.0" @@ -97214,12 +99216,6 @@ ], "response": [ {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -97230,11 +99226,17 @@ "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" - } + }, + {} ] }, { @@ -97243,33 +99245,33 @@ "name": "listTungstenFabricFirewallRule", "params": [ { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "firewallruleuuid", + "name": "firewallpolicyuuid", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "firewallpolicyuuid", + "name": "firewallruleuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -97281,94 +99283,94 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "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", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -97387,11 +99389,12 @@ "type": "uuid" }, { - "description": "The display text of the project, defaults to the 'name´.", + "description": "domain ID of the account owning a project", "length": 255, - "name": "displaytext", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "ID of the account owning a project", @@ -97402,12 +99405,11 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a project", + "description": "The display text of the project, defaults to the 'name´.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "account who will be Admin for the project", @@ -97427,90 +99429,13 @@ "related": "", "response": [ { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this project", - "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 virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - {}, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", + "description": "the account name of the project's owners", + "name": "owner", "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 cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - {}, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { @@ -97519,58 +99444,8 @@ "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { @@ -97578,13 +99453,13 @@ "name": "tags", "response": [ { - "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -97593,8 +99468,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -97603,13 +99483,13 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -97618,41 +99498,127 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "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 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 primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + {}, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { @@ -97661,9 +99627,9 @@ "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { "description": "the total memory (in MB) owned by project", @@ -97676,29 +99642,44 @@ "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "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 virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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 total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { "description": "the total number of snapshots stored by this project", @@ -97706,29 +99687,50 @@ "type": "long" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "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 secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" } ], "since": "3.0.0" @@ -97756,6 +99758,7 @@ } ], "response": [ + {}, {}, { "description": "any text associated with the success or failure", @@ -97763,20 +99766,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -97785,13 +99787,6 @@ "isasync": false, "name": "addCiscoVnmcResource", "params": [ - { - "description": "Credentials to access the Cisco VNMC Controller API", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -97813,18 +99808,17 @@ "name": "hostname", "required": true, "type": "string" + }, + { + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" } ], "related": "listCiscoVnmcResources", "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", @@ -97833,6 +99827,14 @@ }, {}, {}, + {}, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -97841,6 +99843,14 @@ "isasync": true, "name": "markDefaultZoneForAccount", "params": [ + { + "description": "Name of the account that is to be marked.", + "length": 255, + "name": "account", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": true, + "type": "string" + }, { "description": "Marks the account that belongs to the specified domain.", "length": 255, @@ -97856,52 +99866,63 @@ "related": "listZones", "required": true, "type": "uuid" - }, - { - "description": "Name of the account that is to be marked.", - "length": 255, - "name": "account", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "required": true, - "type": "string" } ], "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "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", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the name of the account", + "name": "name", + "type": "string" }, - {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { @@ -97910,29 +99931,34 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "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 total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { "description": "the total number of public ip addresses allocated for this account", @@ -97940,55 +99966,69 @@ "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "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) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "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 number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { "description": "The tagged resource limit and count for the account", @@ -97996,9 +100036,9 @@ "type": "list" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { "description": "account type (admin, domain-admin, user)", @@ -98006,13 +100046,18 @@ "type": "integer" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -98021,62 +100066,88 @@ "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "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", + "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", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, + { + "description": "the 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 account", - "name": "vpcavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "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 cpu cores the account can own", + "name": "cpulimit", + "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", + "name": "volumeavailable", "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, { "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -98085,8 +100156,13 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -98095,18 +100171,23 @@ "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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" }, { @@ -98119,16 +100200,6 @@ "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": "true if user is default, false otherwise", "name": "isdefault", @@ -98140,40 +100211,25 @@ "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user name", + "name": "username", + "type": "string" }, { "description": "the user state", "name": "state", "type": "string" }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, { "description": "the name of the role", "name": "rolename", @@ -98185,46 +100241,37 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the user email address", + "name": "email", "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" } ], "type": "list" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + {}, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -98233,73 +100280,38 @@ "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "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", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" } ], @@ -98311,17 +100323,17 @@ "name": "revokeCertificate", "params": [ { - "description": "The certificate CN", + "description": "The certificate serial number, as a hex value", "length": 255, - "name": "cn", - "required": false, + "name": "serial", + "required": true, "type": "string" }, { - "description": "The certificate serial number, as a hex value", + "description": "The certificate CN", "length": 255, - "name": "serial", - "required": true, + "name": "cn", + "required": false, "type": "string" }, { @@ -98333,6 +100345,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", @@ -98344,17 +100361,12 @@ "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.11.0" }, @@ -98379,6 +100391,7 @@ "type": "string" }, {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -98393,8 +100406,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.20.0" }, @@ -98429,24 +100441,20 @@ ], "related": "startSystemVm", "response": [ + {}, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -98455,99 +100463,93 @@ "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the hostname for the system VM", + "name": "hostname", "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 network domain for the system VM", - "name": "networkdomain", + "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 link local IP address for the system vm", + "name": "linklocalip", "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 Pod name for the system VM", - "name": "podname", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "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 Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { @@ -98561,13 +100563,23 @@ "type": "boolean" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { @@ -98576,13 +100588,18 @@ "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -98591,39 +100608,39 @@ "type": "integer" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, - {}, { - "description": "the ID of the system VM", - "name": "id", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, + {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { @@ -98632,14 +100649,14 @@ "type": "string" }, { - "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 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" } ] }, @@ -98648,14 +100665,6 @@ "isasync": false, "name": "updateSiocInfo", "params": [ - { - "description": "Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "Shares per GB", "length": 255, @@ -98677,6 +100686,14 @@ "required": true, "type": "integer" }, + { + "description": "Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "Storage Pool ID", "length": 255, @@ -98693,18 +100710,45 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", "type": "string" }, {}, + {} + ], + "since": "4.11.0" + }, + { + "description": "Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console", + "isasync": false, + "name": "cloudianSsoLogin", + "params": [], + "related": "", + "response": [ + { + "description": "the sso redirect 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" + } ], "since": "4.11.0" }, @@ -98723,270 +100767,403 @@ } ], "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" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Unmanage a guest virtual machine.", + "isasync": true, + "name": "unmanageVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine to unmanage", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" + }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Starts a router.", + "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, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" + } + ], + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + {}, + { + "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": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "CPU arch of the router", + "name": "arch", + "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.2.0" - }, - { - "description": "Unmanage a guest virtual machine.", - "isasync": true, - "name": "unmanageVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine to unmanage", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "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": "details of the unmanage VM operation", - "name": "details", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Starts a router.", - "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": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "Force reboot the router (Router is force Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" - } - ], - "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, + {}, { - "description": "the id of the router", - "name": "id", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "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 netmask of the nic", - "name": "netmask", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "result of the health check", + "name": "success", "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ { - "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": "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the 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": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "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", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the ID of the nic", @@ -98994,13 +101171,8 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -99009,38 +101181,43 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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" }, { @@ -99049,18 +101226,18 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -99069,155 +101246,37 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "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": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - {}, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" } ], - "type": "list" + "type": "set" }, { "description": "the Pod name for the router", @@ -99225,59 +101284,49 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "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 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 ID associated with the router", - "name": "domainid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" } ] }, @@ -99286,6 +101335,14 @@ "isasync": false, "name": "listNics", "params": [ + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the ID of the nic to list IPs", "length": 255, @@ -99295,49 +101352,41 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list nic of the specific vm's network", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "string" - }, - { - "description": "the ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the vm", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "list nic of the specific vm's network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", @@ -99348,90 +101397,99 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the nic", + "name": "id", "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, - {}, { "description": "the broadcast uri of the nic", "name": "broadcasturi", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the 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": "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 ID of the corresponding network", + "name": "networkid", "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" }, { @@ -99440,74 +101498,65 @@ "type": "list" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, + {}, { "description": "the isolation uri of the nic", "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -99517,61 +101566,53 @@ "name": "listBgpPeers", "params": [ { - "description": "List by keyword", + "description": "AS number of the Bgp Peer.", "length": 255, - "name": "keyword", + "name": "asnumber", "required": false, - "type": "string" + "type": "long" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the domain ID which the Bgp Peer is dedicated to.", + "description": "UUID of the Bgp Peer.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", "required": false, "type": "uuid" }, { - "description": "project who which the Bgp Peer is dedicated to", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "AS number of the Bgp Peer.", + "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": "asnumber", + "name": "isdedicated", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "isdedicated", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "UUID of the Bgp Peer.", + "description": "the domain ID which the Bgp Peer is dedicated to.", "length": 255, - "name": "id", - "related": "listBgpPeers,releaseBgpPeer", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -99583,10 +101624,18 @@ "required": false, "type": "uuid" }, + { + "description": "project who which the Bgp Peer is dedicated to", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -99594,35 +101643,34 @@ "related": "releaseBgpPeer", "response": [ { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - {}, { "description": "id of the bgp peer", "name": "id", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "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": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, { "description": "IPv4 address of bgp peer", @@ -99630,23 +101678,24 @@ "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "password of bgp peer", - "name": "password", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -99655,24 +101704,24 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, - {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, + {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the account of the bgp peer", + "name": "account", "type": "string" } ], @@ -99683,13 +101732,6 @@ "isasync": true, "name": "createSnapshotFromVMSnapshot", "params": [ - { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "The ID of the VM snapshot", "length": 255, @@ -99702,26 +101744,64 @@ "description": "The ID of the disk volume", "length": 255, "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" + }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -99729,19 +101809,25 @@ "name": "datastorestate", "type": "string" }, + {}, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { @@ -99750,27 +101836,37 @@ "type": "boolean" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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 name where tag belongs to", + "name": "project", "type": "string" }, { @@ -99779,8 +101875,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -99789,18 +101885,18 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -99809,66 +101905,31 @@ "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { @@ -99877,50 +101938,33 @@ "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - {}, - {}, - { - "description": "name of the disk volume", - "name": "volumename", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "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", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -99929,14 +101973,19 @@ "type": "state" }, { - "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": "state of the disk volume", - "name": "volumestate", - "type": "string" + "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" } ], "since": "4.10.0" @@ -99946,6 +101995,20 @@ "isasync": false, "name": "listImageStoreObjects", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "path to list on image store", "length": 255, @@ -99967,63 +102030,45 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "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": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, - {}, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "Name of the data store object.", + "name": "name", "type": "string" }, { @@ -100032,25 +102077,29 @@ "type": "long" }, { - "description": "Name of the data store object.", - "name": "name", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, - {}, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", - "type": "string" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -100061,20 +102110,19 @@ "name": "dedicateGuestVlanRange", "params": [ { - "description": "physical network ID of the vlan", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "project who will own the VLAN", + "description": "account who will own the VLAN", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "guest vlan range to be dedicated", @@ -100084,42 +102132,34 @@ "type": "string" }, { - "description": "account who will own the VLAN", + "description": "physical network ID of the vlan", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "project who will own the VLAN", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the ID of the guest VLAN range", - "name": "id", - "type": "string" - }, { "description": "the account of the guest VLAN range", "name": "account", "type": "string" }, + {}, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - }, - { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project name of the guest vlan range", @@ -100131,21 +102171,34 @@ "name": "projectid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "path of the domain to which the guest VLAN range belongs", "name": "domainpath", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { @@ -100153,15 +102206,11 @@ "name": "guestvlanrange", "type": "string" }, + {}, { "description": "the zone of the guest vlan range", "name": "zoneid", "type": "long" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" } ] }, @@ -100171,119 +102220,186 @@ "name": "updateIso", "params": [ { - "description": "the format for the image", - "length": 255, - "name": "format", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "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 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": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" - }, - { - "description": "true if the image supports the password reset feature; default is false", + "description": "true if template/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": "the ID of the image file", + "description": "the name of the image file", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "isdynamicallyscalable", + "name": "bootable", "required": false, "type": "boolean" }, { - "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" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "details", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isrouting", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "bootable", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "sort key of the template, integer", + "description": "the format for the image", "length": 255, - "name": "sortkey", + "name": "format", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "the ID of the image file", "length": 255, - "name": "requireshvm", + "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": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "sshkeyenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "map" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { @@ -100292,125 +102408,120 @@ "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, - {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, + {}, { "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "name": "isdynamicallyscalable", "type": "boolean" }, + {}, { "description": "additional key/value details tied with template", "name": "details", "type": "map" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "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 date this template was created", - "name": "created", - "type": "date" + "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 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 template ID", + "name": "id", + "type": "string" }, { - "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -100419,206 +102530,144 @@ "type": "map" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "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 name of the OS type for this template.", - "name": "ostypename", + "description": "the name of the zone for this template", + "name": "zonename", "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 project id of the template", - "name": "projectid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the list of resource tags associated", - "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the status of the template", - "name": "status", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" } ] }, @@ -100647,17 +102696,17 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -100666,6 +102715,13 @@ "isasync": true, "name": "issueCertificate", "params": [ + { + "description": "Comma separated list of IP addresses, the certificate should be issued for", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, @@ -100681,9 +102737,9 @@ "type": "integer" }, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", + "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": "ipaddress", + "name": "domain", "required": false, "type": "string" }, @@ -100693,44 +102749,37 @@ "name": "csr", "required": false, "type": "string" - }, - { - "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", - "length": 255, - "name": "domain", - "required": false, - "type": "string" } ], "related": "listCaCertificate", "response": [ { - "description": "The CA certificate(s)", - "name": "cacertificates", - "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 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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, + {} ], "since": "4.11.0" }, @@ -100740,19 +102789,18 @@ "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 ending port of port forwarding rule's private port range", "length": 255, - "name": "openfirewall", + "name": "privateendport", "required": false, - "type": "boolean" + "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 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": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { "description": "the ID of the virtual machine for the port forwarding rule", @@ -100763,12 +102811,27 @@ "type": "uuid" }, { - "description": "the starting port of port forwarding rule's public port range", + "description": "the starting port of port forwarding rule's private port range", "length": 255, - "name": "publicport", + "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).", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -100777,6 +102840,13 @@ "since": "4.4", "type": "boolean" }, + { + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, { "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, @@ -100793,93 +102863,46 @@ "type": "uuid" }, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "publicendport", - "required": false, - "type": "integer" - }, - { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "description": "the starting port of port forwarding rule's public port range", "length": 255, - "name": "protocol", + "name": "publicport", "required": true, - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "type": "integer" }, { "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "privateendport", + "name": "publicendport", "required": false, "type": "integer" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" } ], "related": "updatePortForwardingRule", "response": [ + {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "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 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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { @@ -100887,13 +102910,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -100902,13 +102925,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -100917,56 +102940,47 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { "description": "the starting port of port forwarding rule's private port range", "name": "privateport", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -100975,88 +102989,48 @@ "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", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the Name of the Zone", - "name": "zonename", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "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 domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, - {}, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", - "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", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" } ] @@ -101066,6 +103040,14 @@ "isasync": false, "name": "prepareTemplate", "params": [ + { + "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, { "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, @@ -101081,133 +103063,69 @@ "related": "listZones", "required": true, "type": "uuid" - }, - { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ - { - "description": "the account name to which the template belongs", - "name": "account", - "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": "CPU Arch of the template", - "name": "arch", - "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", + "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 the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "additional key/value details tied with template", + "name": "details", "type": "map" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "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 template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "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 status of the template", - "name": "status", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { @@ -101215,13 +103133,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -101230,13 +103148,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -101245,18 +103163,18 @@ "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": "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" }, { @@ -101265,46 +103183,76 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -101313,19 +103261,19 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -101333,9 +103281,24 @@ "type": "string" }, { - "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": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { "description": "the physical size of the template", @@ -101343,8 +103306,79 @@ "type": "long" }, { - "description": "additional key/value details tied with template", - "name": "details", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { @@ -101352,87 +103386,194 @@ "name": "passwordenabled", "type": "boolean" }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + } + ] + }, + { + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", + "params": [ + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, + {}, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "the type of the template", - "name": "templatetype", + "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 Zone", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": "Updates a backup offering.", + "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 template ID", + "description": "The ID of the Backup Offering to be updated", + "length": 255, "name": "id", + "related": "updateBackupOffering", + "required": true, + "type": "uuid" + }, + { + "description": "Whether to allow user driven backups or not", + "length": 255, + "name": "allowuserdrivenbackups", + "required": false, + "type": "boolean" + }, + { + "description": "The description of the Backup Offering to be updated", + "length": 255, + "name": "description", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date this backup offering was created", + "name": "created", + "type": "date" }, + {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "description for the backup offering", + "name": "description", "type": "string" }, { - "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 backup offering", + "name": "id", + "type": "string" }, { - "description": "the template name", + "description": "zone ID", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" + }, + { + "description": "name for the backup offering", "name": "name", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "zone name", + "name": "zonename", + "type": "string" } - ] + ], + "since": "4.16.0" }, { "description": "Lists all Buckets.", @@ -101440,12 +103581,12 @@ "name": "listBuckets", "params": [ { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "the ID of the bucket", "length": 255, - "name": "ids", + "name": "id", "related": "listBuckets", "required": false, - "type": "list" + "type": "uuid" }, { "description": "", @@ -101455,63 +103596,63 @@ "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 keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "projectid", - "related": "", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the bucket", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "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 ID of the bucket", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "listBuckets", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -101522,40 +103663,50 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the name of the bucket", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, { "description": "Bucket Quota in GB", "name": "quota", "type": "integer" }, { - "description": "Bucket Versioning", - "name": "versioning", + "description": "Bucket Object Locking", + "name": "objectlocking", "type": "boolean" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { @@ -101564,33 +103715,34 @@ "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, + {}, + { + "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": "State of the Bucket", - "name": "state", + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" - }, - { - "description": "Bucket Access Policy", - "name": "policy", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { @@ -101602,34 +103754,39 @@ "name": "account", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -101638,74 +103795,63 @@ "type": "string" }, { - "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 domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Object storage provider", + "name": "provider", + "type": "string" }, - {}, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "State of the Bucket", + "name": "state", + "type": "string" }, - {}, { - "description": "Bucket URL", - "name": "url", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", - "type": "string" - }, - { - "description": "Bucket Access Key", - "name": "accesskey", - "type": "string" + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" }, { - "description": "Object storage provider", - "name": "provider", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "name of the Bucket", @@ -101713,19 +103859,14 @@ "type": "string" }, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" } ], "since": "4.19.0" @@ -101753,39 +103894,14 @@ ], "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, { "description": "the first IPv6 DNS for the router", "name": "ip6dns1", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "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 version of template", - "name": "version", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -101794,91 +103910,28 @@ "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "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 name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { @@ -101886,49 +103939,24 @@ "name": "jobid", "type": "string" }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -101936,98 +103964,93 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "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 IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "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 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": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "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", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -102036,102 +104059,126 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "set" }, - {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -102140,23 +104187,33 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { @@ -102165,29 +104222,82 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "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": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, { "description": "path of the Domain the router belongs to", "name": "domainpath", "type": "string" }, + {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "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 state of the router", - "name": "state", - "type": "state" + "description": "the version of template", + "name": "version", + "type": "string" }, { "description": "the guest MAC address for the router", @@ -102195,119 +104305,227 @@ "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, + {}, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" } ] }, { - "description": "Updates a security group", + "description": "SP initiated SAML Single Sign On", "isasync": false, - "name": "updateSecurityGroup", + "name": "samlSso", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Identity Provider Entity ID", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "idpid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "The new name of the security group.", - "length": 255, - "name": "name", - "required": false, + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "The ID of the security group.", - "length": 255, - "name": "id", - "related": "updateSecurityGroup", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "user time zone", + "name": "timezone", + "type": "string" + }, {}, { - "description": "the project name of the group", - "name": "project", + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" + }, + { + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", + "type": "string" + }, + { + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the account name the user belongs to", + "name": "account", + "type": "string" + }, + { + "description": "Is user registered", + "name": "registered", + "type": "string" + }, + { + "description": "the time period before the session has expired", + "name": "timeout", "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the current status of the latest async job 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": "Updates a security group", + "isasync": false, + "name": "updateSecurityGroup", + "params": [ + { + "description": "The ID of the security group.", + "length": 255, + "name": "id", + "related": "updateSecurityGroup", + "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, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 list of resource tags associated with the rule", "name": "tags", @@ -102323,57 +104541,57 @@ "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": "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": "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": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the CIDR notation for the base IP address of the security group rule", @@ -102381,129 +104599,78 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the 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": "security group name", - "name": "securitygroupname", + "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", + "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 account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "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": "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 type of the ICMP message response", "name": "icmptype", "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -102513,44 +104680,39 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "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 project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -102559,44 +104721,106 @@ "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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": "account owning the security group rule", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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": "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": "tag value", + "name": "value", "type": "string" } ], "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" }, { @@ -102604,9 +104828,40 @@ "name": "account", "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 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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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" } ], @@ -102618,122 +104873,117 @@ "name": "createDomain", "params": [ { - "description": "Network domain for networks in the domain", + "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", "length": 255, - "name": "networkdomain", + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "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" }, { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "description": "Network domain for networks in the domain", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomains,listDomains", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Domain UUID, required for adding domain from another Region", + "description": "creates domain with this name", "length": 255, - "name": "domainid", - "required": false, + "name": "name", + "required": true, "type": "string" } ], "related": "listDomains,listDomains", "response": [ { - "description": "the ID of the domain", - "name": "id", + "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 public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the state of the domain", + "name": "state", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { "description": "the total number of snapshots available for this domain", @@ -102741,64 +104991,65 @@ "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "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 projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "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", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the 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 total number of templates available to be created by this domain", + "name": "templateavailable", "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 primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { "description": "the network domain", @@ -102806,80 +105057,94 @@ "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, - {}, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "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 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 volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { "description": "the total number of cpu cores the domain can own", @@ -102887,28 +105152,18 @@ "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" } ] @@ -102919,11 +105174,11 @@ "name": "addImageStore", "params": [ { - "description": "the name for the image store", + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "the URL for the image store", @@ -102933,65 +105188,55 @@ "type": "string" }, { - "description": "the image store provider name", + "description": "the Zone ID for the image store", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "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", + "description": "the name for the image store", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "the image store provider name", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "name": "provider", + "required": true, + "type": "string" } ], "related": "addSecondaryStorage,listSwifts", "response": [ - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, { "description": "the total disk size of the host", "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -103004,9 +105249,9 @@ "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "defines if store is read-only", @@ -103018,16 +105263,26 @@ "name": "name", "type": "string" }, - {}, { - "description": "the provider name of the image store", - "name": "providername", + "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 Zone ID of the image store", + "name": "zoneid", + "type": "string" } ], "since": "4.2.0" @@ -103038,26 +105293,25 @@ "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "(optional) zone to revoke certificate", + "description": "id of the certificate", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, "type": "uuid" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(optional) hypervisor type", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "id of the certificate", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, @@ -103069,18 +105323,25 @@ "type": "string" }, { - "description": "(optional) hypervisor type", + "description": "(optional) zone to revoke certificate", "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "provisionTemplateDirectDownloadCertificate", "response": [ { - "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" + }, + {}, + { + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -103095,20 +105356,14 @@ }, {}, { - "description": "the name of the host", - "name": "hostname", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { "description": "the current status of the latest async job 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.13" @@ -103130,24 +105385,19 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { "description": "the name of the storage pool", @@ -103155,49 +105405,50 @@ "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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 Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { "description": "the storage pool capabilities", @@ -103205,51 +105456,30 @@ "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 name of the cluster for the storage pool", "name": "clustername", "type": "string" }, { - "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { "description": "the overprovisionfactor for the storage pool", @@ -103257,9 +105487,9 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -103267,8 +105497,8 @@ "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" }, { @@ -103277,19 +105507,49 @@ "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, { "description": "the storage pool type", "name": "type", "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" } ], "since": "4.16.0" @@ -103299,19 +105559,11 @@ "isasync": false, "name": "assignVolume", "params": [ - { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", - "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", - "required": false, - "type": "uuid" - }, { "description": "The ID of the volume to be reassigned.", "length": 255, "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" }, @@ -103322,119 +105574,171 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "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 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": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", + "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", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { "description": "ID of the snapshot from which this volume was created", @@ -103442,34 +105746,34 @@ "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { "description": "provisioning type used to create volumes.", @@ -103477,39 +105781,34 @@ "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { "description": "the ID of the ISO attached to the virtual machine", @@ -103517,70 +105816,69 @@ "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "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": "pod name of the volume", - "name": "podname", + "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 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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, - {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { "description": "the state of the disk volume", @@ -103588,167 +105886,129 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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 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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "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": "pod id of the volume", - "name": "podid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, - {}, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "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" } ], "since": "4.18.0.0" @@ -103774,13 +106034,6 @@ "required": false, "type": "uuid" }, - { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, @@ -103788,30 +106041,37 @@ "related": "listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.18" @@ -103822,9 +106082,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" }, @@ -103838,104 +106098,104 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "network service name to list providers and capabilities of", "length": 255, - "name": "page", + "name": "service", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" + "description": "the current status of the latest async job 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 service name", "name": "name", "type": "string" }, + {}, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the provider name", "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { "description": "uuid of the network provider", "name": "id", "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "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" @@ -103958,26 +106218,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": "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" } ] @@ -103988,27 +106248,19 @@ "name": "addNetworkServiceProvider", "params": [ { - "description": "the destination Physical Network ID to bridge to", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "destinationphysicalnetworkid", - "related": "", + "name": "servicelist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the Physical Network ID to add the provider to", + "description": "the destination Physical Network ID to bridge to", "length": 255, - "name": "physicalnetworkid", + "name": "destinationphysicalnetworkid", "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", "required": false, - "type": "list" + "type": "uuid" }, { "description": "the name for the physical network service provider", @@ -104016,20 +106268,35 @@ "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" } ], "related": "listTrafficTypes", "response": [ { - "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": "the provider 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" + }, + {}, + {}, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -104041,31 +106308,24 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, - {}, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "since": "3.0.0" @@ -104085,17 +106345,7 @@ } ], "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", @@ -104106,7 +106356,17 @@ "name": "success", "type": "boolean" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -104125,9 +106385,14 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -104136,16 +106401,11 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], "since": "4.18.0.0" }, @@ -104155,76 +106415,84 @@ "name": "createServiceOffering", "params": [ { - "description": "max iops of the compute offering", + "description": "the ID of the disk offering to which service offering should be mapped", "length": 255, - "name": "maxiops", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.4", - "type": "long" + "since": "4.17", + "type": "uuid" }, { - "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": "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": "isvolatile", + "name": "deploymentplanner", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "displaytext", + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "networkrate", + "name": "storagetype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "details for planner, used to store specific parameters", + "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", "length": 255, - "name": "serviceofferingdetails", + "name": "purgeresources", "required": false, - "type": "map" + "since": "4.20", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "byteswriterate", "required": false, "type": "long" }, { - "description": "whether compute offering iops is custom or not", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "customizediops", + "name": "bytesreadrate", "required": false, - "since": "4.4", - "type": "boolean" + "type": "long" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "is this a system vm offering", "length": 255, - "name": "mincpunumber", + "name": "issystem", "required": false, - "since": "4.13", - "type": "integer" + "type": "boolean" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "the name of the service offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "limitcpuuse", + "name": "encryptroot", "required": false, + "since": "4.18", "type": "boolean" }, { @@ -104235,19 +106503,27 @@ "type": "string" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "maxmemory", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "since": "4.13", - "type": "integer" + "type": "list" }, { - "description": "length (in seconds) of the burst", + "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": "iopsreadratemaxlength", + "name": "diskofferingstrictness", "required": false, - "type": "long" + "since": "4.17", + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" }, { "description": "the total memory of the service offering in MB", @@ -104257,62 +106533,63 @@ "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "byteswriteratemax", + "name": "maxcpunumber", "required": false, - "type": "long" + "since": "4.13", + "type": "integer" }, { - "description": "the CPU number of the service offering", + "description": "the HA for the service offering", "length": 255, - "name": "cpunumber", + "name": "offerha", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "cpuspeed", + "name": "mincpunumber", "required": false, + "since": "4.13", "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" }, { - "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "purgeresources", + "name": "customizediops", "required": false, - "since": "4.20", + "since": "4.4", "type": "boolean" }, { - "description": "the ID of the disk offering to which service offering should be mapped", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "iopswriterate", "required": false, - "since": "4.17", - "type": "uuid" + "type": "long" }, { - "description": "the tags for this service offering.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "list" }, { - "description": "bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriterate", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, @@ -104325,392 +106602,370 @@ "type": "boolean" }, { - "description": "the host tag for this service offering.", + "description": "min iops of the compute offering", "length": 255, - "name": "hosttags", + "name": "miniops", "required": false, - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "the Root disk size in GB.", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "rootdisksize", + "name": "iopsreadratemax", "required": false, - "since": "4.15", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "cachemode", + "name": "limitcpuuse", "required": false, - "since": "4.14", - "type": "string" + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "length (in seconds) of the burst", "length": 255, - "name": "dynamicscalingenabled", + "name": "iopswriteratemaxlength", "required": false, - "since": "4.16", - "type": "boolean" + "type": "long" }, { - "description": "the HA for the service offering", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "offerha", + "name": "systemvmtype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "the CPU number of the service offering", "length": 255, - "name": "minmemory", + "name": "cpunumber", "required": false, - "since": "4.13", "type": "integer" }, { - "description": "io requests read rate of the disk offering", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "iopsreadrate", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", "length": 255, - "name": "iopswriteratemax", + "name": "isvolatile", "required": false, - "type": "long" + "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", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "diskofferingstrictness", + "name": "iopswriteratemax", "required": false, - "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", "length": 255, - "name": "deploymentplanner", + "name": "cpuspeed", "required": false, - "type": "string" + "type": "integer" }, { - "description": "VMs using this offering require root volume encryption", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "encryptroot", + "name": "hypervisorsnapshotreserve", "required": false, - "since": "4.18", - "type": "boolean" + "since": "4.4", + "type": "integer" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "maxmemory", "required": false, "since": "4.13", - "type": "list" - }, - { - "description": "the name of the service offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "integer" }, { - "description": "burst requests read rate of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "iopsreadratemax", + "name": "storagepolicy", + "related": "", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { - "description": "is this a system vm offering", + "description": "the host tag for this service offering.", "length": 255, - "name": "issystem", + "name": "hosttags", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "maxcpunumber", + "name": "minmemory", "required": false, "since": "4.13", "type": "integer" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" - }, - { - "description": "length (in seconds) of the burst", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "bytesreadratemax", "required": false, "type": "long" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the tags for this service offering.", "length": 255, - "name": "systemvmtype", + "name": "tags", "required": false, "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "max iops of the compute offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "maxiops", "required": false, "since": "4.4", - "type": "integer" + "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "serviceofferingdetails", "required": false, - "type": "list" + "type": "map" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "the Root disk size in GB.", "length": 255, - "name": "storagepolicy", - "related": "", + "name": "rootdisksize", "required": false, "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "The display text of the service offering, defaults to 'name'.", "length": 255, - "name": "bytesreadratemax", + "name": "displaytext", "required": false, - "type": "long" + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "iopswriterate", + "name": "dynamicscalingenabled", "required": false, - "type": "long" + "since": "4.16", + "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "storagetype", + "name": "iopsreadrate", "required": false, - "type": "string" + "type": "long" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, - { - "description": "is this a system vm offering", - "name": "issystem", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - {}, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "state of the service offering", + "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", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "state of the service offering", - "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 date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + {}, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, { "description": "the host tag for the service offering", "name": "hosttags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "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": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the memory in MB", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "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": "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": "the ha support in the service offering", @@ -104718,79 +106973,84 @@ "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "the id of the service offering", + "name": "id", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "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 clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" } ] }, @@ -104799,22 +107059,6 @@ "isasync": false, "name": "assignVirtualMachine", "params": [ - { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", - "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "list" - }, { "description": "an optional project for the new VM owner.", "length": 255, @@ -104831,6 +107075,13 @@ "required": false, "type": "uuid" }, + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, + "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, @@ -104840,67 +107091,263 @@ "type": "list" }, { - "description": "account name of the new VM owner.", + "description": "id of the VM to be moved", "length": 255, - "name": "account", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "string" + "type": "list" } ], "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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", + "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "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" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "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 netmask of the nic", + "name": "netmask", + "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 nic", + "name": "id", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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" + } + ], + "type": "set" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -104908,243 +107355,439 @@ "name": "virtualmachineIds", "type": "list" }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, { "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "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 group name of the virtual machine", - "name": "group", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, + { + "description": "User VM type", + "name": "vmtype", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the 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": "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": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the 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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "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": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "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 high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -105160,12 +107803,32 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -105173,96 +107836,91 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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 key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the 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": "the id of the security group rule", + "name": "ruleid", "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", + "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" }, { @@ -105274,8 +107932,23 @@ "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the 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 ending IP of the security group rule ", @@ -105293,18 +107966,23 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -105312,28 +107990,28 @@ "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": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -105342,28 +108020,28 @@ "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": "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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], @@ -105375,41 +108053,21 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -105417,28 +108075,23 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -105447,80 +108100,59 @@ "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": "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 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", "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -105533,114 +108165,29 @@ "name": "memory", "type": "integer" }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, { "description": "the group ID of the virtual machine", "name": "groupid", "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" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the 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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "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", + "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -105649,373 +108196,163 @@ "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists virtual machines on a unmanaged host", + "isasync": false, + "name": "listVmsForImport", + "params": [ { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the username for the host", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", + "description": "the ID of the host to which virtual machine belongs", "name": "hostid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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" - } - ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "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 updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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, - "type": "string" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "indicates the boot mode", + "name": "bootmode", "type": "string" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, - "type": "string" - } - ], - "related": "listVmwareDcVms,listUnmanagedInstances", - "response": [ { "description": "the list of disks associated with the virtual machine", "name": "disk", "response": [ { - "description": "the ID of the disk", - "name": "id", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { "description": "the file path of the disk image", @@ -106023,13 +108360,13 @@ "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { "description": "the controller of the disk", - "name": "datastorepath", + "name": "datastorehost", "type": "string" }, { @@ -106037,24 +108374,19 @@ "name": "datastorename", "type": "string" }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, { "description": "the position of the disk", "name": "position", "type": "integer" }, { - "description": "the label of the disk", - "name": "label", + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { @@ -106064,39 +108396,49 @@ }, { "description": "the controller of the disk", - "name": "datastorehost", + "name": "controller", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", "type": "string" } ], "type": "set" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of nics associated with the virtual machine", "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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" }, { @@ -106105,28 +108447,38 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, { "description": "the isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -106135,18 +108487,13 @@ "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -106155,43 +108502,43 @@ "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 name of the corresponding network", - "name": "networkname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -106200,8 +108547,8 @@ "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" }, { @@ -106210,99 +108557,27 @@ "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" } ], "type": "set" - }, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" } ], "since": "4.19.0" @@ -106312,13 +108587,6 @@ "isasync": true, "name": "configureNetscalerLoadBalancer", "params": [ - { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "lbdevicecapacity", - "required": false, - "type": "long" - }, { "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", "length": 255, @@ -106335,78 +108603,95 @@ "type": "uuid" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", "length": 255, - "name": "podids", - "related": "createManagementNetworkIpRange", + "name": "inline", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "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": "capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "inline", + "name": "lbdevicecapacity", "required": false, - "type": "boolean" + "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.", + "length": 255, + "name": "podids", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "list" } ], "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ - { - "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 id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, - {}, - {}, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, + {}, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, + {}, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "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 name", - "name": "lbdevicename", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the current status of the latest 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 netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { @@ -106415,28 +108700,18 @@ "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "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": "public IP of the NetScaler representing GSLB site", "name": "gslbproviderpublicip", "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" } ] @@ -106446,13 +108721,6 @@ "isasync": true, "name": "deleteTungstenFabricServiceGroup", "params": [ - { - "description": "the uuid of Tungsten-Fabric service group", - "length": 255, - "name": "servicegroupuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -106460,18 +108728,20 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, + "type": "string" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -106479,11 +108749,16 @@ "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" } ] }, @@ -106500,11 +108775,11 @@ "type": "string" }, { - "description": "the name for the object store", + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { "description": "the object store provider name", @@ -106514,33 +108789,37 @@ "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the name for the object store", "length": 255, - "name": "tags", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "description": "the tags for the storage pool", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "map" + "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 object store", + "name": "name", + "type": "string" }, - {}, { "description": "the url of the object store", "name": "url", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the provider name of the object store", "name": "providername", @@ -106551,31 +108830,27 @@ "name": "id", "type": "string" }, - { - "description": "the name of the object store", - "name": "name", - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the total size of the object store", "name": "storagetotal", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -106586,35 +108861,35 @@ "name": "deleteUserFromProject", "params": [ { - "description": "ID of the project to remove the user from", + "description": "Id of the user to be removed from the project", "length": 255, - "name": "projectid", - "related": "", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": true, "type": "uuid" }, { - "description": "Id of the user to be removed from the project", + "description": "ID of the project to remove the user from", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "projectid", + "related": "", "required": true, "type": "uuid" } ], "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", @@ -106644,26 +108919,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "3.0.0" @@ -106674,45 +108949,43 @@ "name": "listNetworkDevice", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "parameters for network device", + "description": "", "length": 255, - "name": "networkdeviceparameterlist", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "List by keyword", "length": 255, - "name": "networkdevicetype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "parameters for network device", "length": 255, - "name": "pagesize", + "name": "networkdeviceparameterlist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "page", + "name": "networkdevicetype", "required": false, - "type": "integer" + "type": "string" } ], "related": "addNetworkDevice", "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -106723,11 +108996,13 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the ID of the network device", "name": "id", "type": "string" - } + }, + {} ] }, { @@ -106736,19 +109011,12 @@ "name": "listProjectRoles", "params": [ { - "description": "List by keyword", + "description": "List project role by project role name.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -106757,9 +109025,9 @@ "type": "integer" }, { - "description": "List project role by project role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -106778,46 +109046,53 @@ "related": "listProjectRoles,updateProjectRole", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "updateProjectRole", "response": [ { - "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", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the id of the project", "name": "projectid", "type": "string" }, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.15.0" @@ -106839,13 +109114,15 @@ "related": "", "response": [ { - "description": "the url of the controller api", - "name": "url", + "description": "device id of the controller", + "name": "id", "type": "string" }, + {}, + {}, { - "description": "device id of the controller", - "name": "id", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { @@ -106853,26 +109130,24 @@ "name": "physicalnetworkid", "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 username to authenticate to the controller", - "name": "username", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -106883,26 +109158,18 @@ "name": "updateTemplate", "params": [ { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the name of the image file", "length": 255, - "name": "sshkeyenabled", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "templatetype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the display text of the image", @@ -106912,20 +109179,27 @@ "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 supports the sshkey upload feature; default is false", "length": 255, - "name": "templatetype", + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "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 the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, { "description": "the ID of the image file", "length": 255, @@ -106935,24 +109209,26 @@ "type": "uuid" }, { - "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": "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 image.", "length": 255, - "name": "isrouting", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the format for the image", + "description": "the tag for this template.", "length": 255, - "name": "format", + "name": "templatetag", "required": false, + "since": "4.20.0", "type": "string" }, { @@ -106963,31 +109239,30 @@ "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "arch", + "name": "isrouting", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "cleanupdetails", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "sort key of the template, integer", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "sortkey", + "name": "bootable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the name of the image file", + "description": "the format for the image", "length": 255, - "name": "name", + "name": "format", "required": false, "type": "string" }, @@ -106999,9 +109274,9 @@ "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "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": "requireshvm", + "name": "cleanupdetails", "required": false, "type": "boolean" } @@ -107009,63 +109284,37 @@ "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the type of the template", - "name": "templatetype", + "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": "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "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": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -107074,18 +109323,18 @@ "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -107094,58 +109343,68 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project 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" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" }, {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "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": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "checksum of the template", @@ -107153,18 +109412,38 @@ "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 name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { @@ -107173,129 +109452,135 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, + {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "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 tag of this template", "name": "templatetag", "type": "string" }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, { "description": "the format of the template.", "name": "format", "type": "imageformat" }, { - "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": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "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 date this template was removed", - "name": "removed", - "type": "date" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "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 project name of the template", - "name": "project", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { "description": "the name of the OS type for this template.", @@ -107308,43 +109593,33 @@ "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" } ] @@ -107355,99 +109630,78 @@ "name": "createVlanIpRange", "params": [ { - "description": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the Zone ID of the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "forsystemvms", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "account", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "ip6gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "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": "forvirtualnetwork", + "name": "vlan", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the physical network id", + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "physicalnetworkid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, - { - "description": "the ending IP address in the VLAN IP range", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "endip", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the gateway of the VLAN IP range", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "gateway", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "true if the IP range is used for NSX resource", "length": 255, - "name": "endipv6", + "name": "fornsx", "required": false, - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "netmask", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "ip6cidr", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the beginning IP address in the VLAN IP range", @@ -107457,74 +109711,70 @@ "type": "string" }, { - "description": "true if the IP range is used for NSX resource", - "length": 255, - "name": "fornsx", - "required": false, - "since": "4.20.0", - "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 ending IP address in the VLAN IP range", "length": 255, - "name": "vlan", + "name": "endip", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a VLAN", + "description": "the network id", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "the physical network id", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, { - "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" - } - ], - "related": "updateVlanIpRange", - "response": [ - { - "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 ID or VID of the VLAN.", - "name": "vlan", + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, + "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "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" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "updateVlanIpRange", + "response": [ + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { @@ -107533,70 +109783,65 @@ "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "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": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { "description": "the end ipv6 of the VLAN IP range", "name": "endipv6", "type": "string" }, - { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" - }, { "description": "the domain name of the VLAN IP range", "name": "domain", "type": "string" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "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 account of the VLAN IP range", @@ -107604,40 +109849,70 @@ "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 VLAN IP range", + "name": "startip", + "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, - {}, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { "description": "indicates whether IP range is dedicated to NSX resources or not", "name": "fornsx", "type": "boolean" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "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 Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -107674,64 +109949,24 @@ "related": "", "response": [ { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain name of the owner", + "name": "domain", "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": "IKE policy of the customer gateway", "name": "ikepolicy", "type": "string" }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "is connection 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 id of the owner", - "name": "domainid", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "the project name", @@ -107739,9 +109974,14 @@ "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the connection ID", + "name": "id", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "IPsec Preshared-Key of the customer gateway", @@ -107749,19 +109989,19 @@ "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "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 domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { "description": "the customer gateway ID", @@ -107769,15 +110009,25 @@ "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "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": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, {}, { "description": "the public IP address", @@ -107785,36 +110035,61 @@ "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the owner", + "name": "account", "type": "string" }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the project id", "name": "projectid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "State of vpn connection", + "name": "state", "type": "string" }, - {} + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + {}, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + } ], "since": "4.4" }, @@ -107824,11 +110099,11 @@ "name": "listPaloAltoFirewallNetworks", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "palo alto balancer device ID", @@ -107839,16 +110114,16 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -107856,131 +110131,74 @@ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the list of resource tags associated with network", - "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 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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "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 gateway of IPv6 network", - "name": "ip6gateway", + "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": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { "description": "display text of the network offering the network is created from", @@ -107988,94 +110206,115 @@ "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, {}, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "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 routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, + {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { @@ -108109,13 +110348,8 @@ "name": "provider", "response": [ { - "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" }, { @@ -108123,6 +110357,11 @@ "name": "servicelist", "type": "list" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -108139,8 +110378,8 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -108155,29 +110394,34 @@ "type": "list" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "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", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "The external id of the network", @@ -108185,25 +110429,24 @@ "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "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": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "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": "path of the Domain the network belongs to", @@ -108211,39 +110454,39 @@ "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "true if network 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": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { "description": "network offering id the network is created from", @@ -108251,54 +110494,54 @@ "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "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 IPv4 routing type of network", - "name": "ip4routing", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the ID of the Network associated with this network", + "description": "the ID of the Network associated with this private gateway", "name": "associatednetworkid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "state of the network", - "name": "state", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { "description": "true if network supports specifying ip ranges, false otherwise", @@ -108306,28 +110549,8 @@ "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { @@ -108336,54 +110559,111 @@ "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" } ] }, @@ -108403,11 +110683,10 @@ "related": "", "response": [ { - "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" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -108415,10 +110694,11 @@ }, {}, { - "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" - } + }, + {} ] }, { @@ -108426,6 +110706,13 @@ "isasync": false, "name": "listManagementServers", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the id of the management server", "length": 255, @@ -108435,11 +110722,12 @@ "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": "", @@ -108449,50 +110737,61 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the management server", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the name of the management server", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the IP Address for this Management Server", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the management server", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the version of the management server", - "name": "version", + "description": "the name of the management server", + "name": "name", "type": "string" }, { @@ -108501,41 +110800,40 @@ "type": "date" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "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" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the ID of the management server", + "name": "id", "type": "string" }, {}, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", - "type": "string" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the version of the management server", + "name": "version", + "type": "string" }, - {}, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" } ] }, @@ -108545,23 +110843,31 @@ "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric rule", "length": 255, - "name": "keyword", + "name": "ruleuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "ruleuuid", + "name": "policyuuid", + "required": true, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -108573,38 +110879,29 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "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" } ], "related": "addTungstenFabricPolicyRule", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { "description": "Tungsten-Fabric policy name", @@ -108612,73 +110909,70 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", + "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", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", "type": "int" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", "type": "int" }, { @@ -108686,7 +110980,11 @@ "name": "zonename", "type": "string" }, - {} + { + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + } ] }, { @@ -108711,17 +111009,16 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -108732,7 +111029,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -108758,11 +111056,10 @@ ], "related": "", "response": [ - {}, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -108770,49 +111067,50 @@ "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the instance group", - "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 the instance group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" }, { "description": "the ID of the instance group", @@ -108836,33 +111134,33 @@ "type": "uuid" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "the zone where certificates are uploaded", "length": 255, - "name": "listhosts", + "name": "zoneid", + "related": "listZones", "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 by keyword", + "description": "if set to true: include the hosts where the certificate is uploaded to", "length": 255, - "name": "keyword", + "name": "listhosts", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the zone where certificates are uploaded", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -108875,32 +111173,31 @@ "related": "", "response": [ { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, - {}, { "description": "the direct download certificate version", "name": "version", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -108912,8 +111209,13 @@ "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { @@ -108922,8 +111224,8 @@ "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { @@ -108931,14 +111233,10 @@ "name": "hostsmap", "type": "list" }, + {}, { - "description": "the direct download certificate issuer", - "name": "issuer", - "type": "string" - }, - { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -108957,19 +111255,19 @@ "type": "integer" }, { - "description": "the ID of the ucs manager", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listUcsManagers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the ucs manager", "length": 255, - "name": "page", + "name": "id", + "related": "listUcsManagers", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the zone id", @@ -108980,11 +111278,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", @@ -108994,9 +111292,10 @@ "name": "id", "type": "string" }, + {}, { - "description": "the url of ucs manager", - "name": "url", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, {}, @@ -109005,22 +111304,21 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the name of ucs manager", - "name": "name", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, - {} + { + "description": "the name of ucs manager", + "name": "name", + "type": "string" + } ] }, { @@ -109048,208 +111346,197 @@ "related": "listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the version of template", + "name": "version", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "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 version of scripts", - "name": "scriptsversion", + "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 date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public IP address for the router", + "name": "publicip", "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 public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 netmask of the nic", + "name": "netmask", + "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -109258,43 +111545,43 @@ "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the type of the nic", + "name": "type", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -109303,8 +111590,8 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -109313,116 +111600,158 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "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 gateway of IPv6 network", - "name": "ip6gateway", + "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": "the ID of the nic", - "name": "id", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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": "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": "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 Zone ID for the router", - "name": "zoneid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + {}, + { + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -109430,52 +111759,52 @@ "name": "healthcheckresults", "response": [ { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { "description": "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" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" } ], "type": "list" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { "description": "the guest netmask for the router", @@ -109483,34 +111812,8 @@ "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "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 public IP address for the router", - "name": "publicip", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" } ] @@ -109521,42 +111824,36 @@ "name": "updateVolume", "params": [ { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", "length": 255, - "name": "displayvolume", + "name": "deleteprotection", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "The state of the volume", + "description": "The path of the volume", "length": 255, - "name": "state", + "name": "path", "required": false, - "since": "4.3", "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" - }, - { - "description": "The path of the volume", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "path", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "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", @@ -109567,156 +111864,152 @@ "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 volume to the end user or not.", "length": 255, - "name": "customid", + "name": "displayvolume", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "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": "the ID of the disk volume", "length": 255, - "name": "deleteprotection", + "name": "id", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "uuid" }, { - "description": "Destination storage pool UUID for the volume", + "description": "The state of the volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "state", "required": false, "since": "4.3", - "type": "uuid" - } - ], - "related": "importVolume,createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "ID of the availability zone", - "name": "zoneid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", "type": "string" - }, + } + ], + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "response": [ { "description": "volume uuid that is given by virtualisation provider (only for VMware)", "name": "externaluuid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "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": "cluster id of the volume", - "name": "clusterid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -109725,104 +112018,104 @@ "type": "long" }, { - "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": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "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", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "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": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, - {}, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "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": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "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": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { @@ -109831,14 +112124,9 @@ "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the display text of the disk offering", @@ -109846,38 +112134,48 @@ "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "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": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { @@ -109885,50 +112183,60 @@ "name": "supportsstoragesnapshot", "type": "boolean" }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, { "description": "the bytes actually consumed on disk", "name": "physicalsize", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, - {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -109936,48 +112244,48 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -109986,36 +112294,31 @@ "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": "name of the disk offering", - "name": "diskofferingname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the virtual machine", + "name": "vmname", "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": "state of the virtual machine", - "name": "vmstate", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" } ] @@ -110034,11 +112337,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -110048,27 +112351,15 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - { - "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": "the provider name", "name": "name", @@ -110084,6 +112375,23 @@ "name": "canenableindividualservice", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + {}, { "description": "state of the network provider", "name": "state", @@ -110098,11 +112406,6 @@ "description": "services for this provider", "name": "servicelist", "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" } ], "since": "3.0.0" @@ -110113,12 +112416,11 @@ "name": "updateAccount", "params": [ { - "description": "The UUID of the dynamic role to set for the account", + "description": "Current account name", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Network domain for the account's networks; empty string will update domainName with NULL value", @@ -110128,25 +112430,34 @@ "type": "string" }, { - "description": "Current account name", + "description": "Details for the account used to store specific parameters", "length": 255, - "name": "account", + "name": "accountdetails", "required": false, - "type": "string" + "type": "map" }, { - "description": "New name for the account", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "newname", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "New name for the account", + "length": 255, + "name": "newname", + "required": false, + "type": "string" }, { "description": "Account UUID", @@ -110157,181 +112468,69 @@ "type": "uuid" }, { - "description": "The UUID of the domain where the account exists", + "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": "domainid", - "related": "listDomains,listDomains", + "name": "apikeyaccess", "required": false, - "type": "uuid" + "since": "4.20.1.0", + "type": "string" } ], "related": "disableAccount,enableAccount,listAccounts", "response": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "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": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "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", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "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 state", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -110345,75 +112544,103 @@ "type": "long" }, { - "description": "the total number of public ip addresses this account 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 snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "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 date when this account was created", - "name": "created", - "type": "date" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, - {}, { - "description": "the name of the account", - "name": "name", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "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 date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, { "description": "true if the account requires cleanup", "name": "iscleanuprequired", "type": "boolean" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", "type": "string" }, { @@ -110422,28 +112649,33 @@ "type": "list" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "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 number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "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 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" }, { @@ -110452,18 +112684,18 @@ "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "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 name of the role", - "name": "rolename", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { @@ -110472,23 +112704,8 @@ "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -110497,23 +112714,8 @@ "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { @@ -110522,14 +112724,9 @@ "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the total memory (in MB) available to be created for this account", @@ -110537,69 +112734,193 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, + {}, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total 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 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 snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "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 total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + } + ], + "type": "list" } ] }, @@ -110627,24 +112948,18 @@ "related": "listSwifts", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -110652,51 +112967,57 @@ "name": "providername", "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 protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, + {}, { - "description": "the 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 name of the image store", - "name": "name", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { "description": "the Zone ID of the image store", "name": "zoneid", "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 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 protocol of the image store", + "name": "protocol", + "type": "string" } ] }, @@ -110705,6 +113026,23 @@ "isasync": false, "name": "updateVirtualMachine", "params": [ + { + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "length": 255, + "name": "name", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" + }, { "description": "The ID of the virtual machine", "length": 255, @@ -110714,35 +113052,34 @@ "type": "uuid" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "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": "securitygroupids", - "related": "", + "name": "cleanupdetails", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "instance name of the user vm", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "instancename", + "name": "displayvm", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "description": "the ID of the OS type that best represents this VM.", "length": 255, - "name": "isdynamicallyscalable", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "length": 255, + "name": "deleteprotection", "required": false, - "since": "4.12", - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -110753,73 +113090,71 @@ "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "list of security group ids to be applied on the virtual machine.", "length": 255, - "name": "userdatadetails", + "name": "securitygroupids", + "related": "", "required": false, - "since": "4.18", - "type": "map" + "type": "list" }, { - "description": "user generated name", + "description": "group of the virtual machine", "length": 255, - "name": "displayname", + "name": "group", "required": false, "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", "length": 255, - "name": "name", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.4", - "type": "string" + "type": "map" }, { - "description": "the ID of the OS type that best represents this VM.", + "description": "true if high-availability is enabled for the virtual machine, false otherwise", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "haenable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "userdatadetails", "required": false, + "since": "4.18", "type": "map" }, { - "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "description": "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": "deleteprotection", + "name": "isdynamicallyscalable", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "instance name of the user vm", "length": 255, - "name": "cleanupdetails", + "name": "instancename", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", - "length": 255, - "name": "details", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, - "type": "map" + "since": "4.12", + "type": "string" }, { - "description": "the ID of the userdata", + "description": "user generated name", "length": 255, - "name": "userdataid", - "related": "", + "name": "displayname", "required": false, - "since": "4.18", - "type": "uuid" + "type": "string" }, { "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", @@ -110830,122 +113165,224 @@ "type": "string" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "", - "required": false, - "type": "list" + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "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": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the user's 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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, + {}, { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, - "type": "boolean" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "type": "boolean" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "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", + "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": "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -110953,6 +113390,16 @@ "name": "sentbytes", "type": "long" }, + { + "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": "VNF details", "name": "vnfdetails", @@ -110964,28 +113411,78 @@ "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the 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", + "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", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -110993,38 +113490,38 @@ "name": "nic", "response": [ { - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -111032,41 +113529,66 @@ "name": "netmask", "type": "string" }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "Type of adapter if available", "name": "adaptertype", "type": "string" }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { "description": "the isolation uri of the nic", "name": "isolationuri", "type": "string" }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the gateway of the nic", "name": "gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "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", @@ -111078,13 +113600,13 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -111093,178 +113615,104 @@ "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", + "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": "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 traffic type of the nic", + "name": "traffictype", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the 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 traffic type of the nic", - "name": "traffictype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, + {}, { - "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the 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": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "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 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", @@ -111276,61 +113724,26 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -111339,59 +113752,99 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the 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": "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 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 id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -111400,32 +113853,89 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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 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 id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -111438,18 +113948,43 @@ "name": "account", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -111458,28 +113993,28 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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 account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -111488,230 +114023,62 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 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 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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of 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": "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": "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" } ], "type": "set" }, { - "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", - "type": "string" - }, - { - "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "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 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", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -111720,19 +114087,14 @@ "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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 name of the virtual machine", + "name": "group", + "type": "string" }, { "description": " an alternate display text of the template for the virtual machine", @@ -111740,113 +114102,97 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "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 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": "User VM type", - "name": "vmtype", + "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 containing the user data", "name": "userdata", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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": "the state of the virtual machine", - "name": "state", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "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 ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the 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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the 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", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the 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": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -111855,23 +114201,18 @@ "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -111879,11 +114220,6 @@ "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", @@ -111895,27 +114231,27 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the name of userdata used for the VM", @@ -111923,33 +114259,23 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" } ] @@ -111959,20 +114285,6 @@ "isasync": true, "name": "disableAccount", "params": [ - { - "description": "Disables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "If true, only lock the account; else disable the account", - "length": 255, - "name": "lock", - "required": true, - "type": "boolean" - }, { "description": "Disables specified account in this domain.", "length": 255, @@ -111981,6 +114293,13 @@ "required": false, "type": "uuid" }, + { + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Account id", "length": 255, @@ -111988,54 +114307,31 @@ "related": "disableAccount,enableAccount,listAccounts", "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 id of the account", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "account type (admin, domain-admin, user)", @@ -112043,48 +114339,13 @@ "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { @@ -112093,97 +114354,62 @@ "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the user state", - "name": "state", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the 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 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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -112192,18 +114418,18 @@ "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -112212,29 +114438,29 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the domain ID of the user", @@ -112247,46 +114473,102 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "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", + "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 secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + {}, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, { "description": "the total number of network traffic bytes sent", "name": "sentbytes", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { @@ -112295,121 +114577,180 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the account", + "name": "name", "type": "string" }, - {}, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, { "description": "the total number of snapshots which can be stored by this account", "name": "snapshotlimit", "type": "string" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, - {}, { "description": "the total memory (in MB) owned by account", "name": "memorytotal", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "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": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "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 vpcs owned by account", - "name": "vpctotal", + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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 volume being used by this account", - "name": "volumetotal", + "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 number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", + "description": "the list of acl groups that account belongs to", + "name": "groups", "type": "list" }, { - "description": "the 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 account", + "name": "iptotal", + "type": "long" }, { "description": "the total primary storage space (in GiB) owned by account", @@ -112417,14 +114758,9 @@ "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" - }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" } ] }, @@ -112434,133 +114770,134 @@ "name": "listDomains", "params": [ { - "description": "List by keyword", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "List domains by domain level.", "length": 255, - "name": "details", + "name": "level", "required": false, - "type": "list" + "type": "integer" }, { - "description": "Tag for resource type to return usage", + "description": "List by keyword", "length": 255, - "name": "tag", + "name": "keyword", "required": false, - "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": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "flag to display the resource icon for domains", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "showicon", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "", + "description": "List domain by domain name.", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List domains by domain level.", + "description": "List domain by domain ID.", "length": 255, - "name": "level", + "name": "id", + "related": "listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { - "description": "List domain by domain ID.", + "description": "", "length": 255, - "name": "id", - "related": "listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List domain by domain name.", + "description": "Tag for resource type to return usage", "length": 255, - "name": "name", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" } ], "related": "listDomains", "response": [ { - "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 domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "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": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, + {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "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 number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { @@ -112574,39 +114911,94 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, { "description": "the total secondary storage space (in GiB) owned by domain", "name": "secondarystoragetotal", "type": "float" }, { - "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 network domain", - "name": "networkdomain", + "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", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { "description": "the total memory (in MB) the domain can own", @@ -112614,23 +115006,34 @@ "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { @@ -112639,200 +115042,318 @@ "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, - {}, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" + } + ] + }, + { + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "isasync": false, + "name": "resetUserDataForVirtualMachine", + "params": [ + { + "description": "an optional project for the virtual machine", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "type": "map" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "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", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the level of the domain", - "name": "level", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "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 cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "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", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" - } - ] - }, - { - "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", - "isasync": false, - "name": "resetUserDataForVirtualMachine", - "params": [ - { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "type": "map" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "an optional project for the virtual machine", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -112842,18 +115363,18 @@ "name": "tags", "response": [ { - "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 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" }, { @@ -112862,13 +115383,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -112882,87 +115408,47 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -112973,33 +115459,33 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -113008,13 +115494,13 @@ "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": "tag value", + "name": "value", "type": "string" }, { @@ -113023,20 +115509,55 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { "description": "the ID of the security group", @@ -113044,41 +115565,51 @@ "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 account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -113087,51 +115618,51 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -113139,40 +115670,15 @@ "name": "cidr", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" } ], "type": "set" @@ -113181,549 +115687,422 @@ "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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the 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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the virtual machine", + "name": "id", "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": "State of the Service from LB rule", - "name": "servicestate", + "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 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", + "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": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 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 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": "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": "Type of adapter if available", - "name": "adaptertype", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "resource type", + "name": "resourcetype", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "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 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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the disk 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 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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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": "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": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the netmask of the nic", + "name": "netmask", "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 ID of the affinity group", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the nic", + "name": "type", "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "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": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "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 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" }, { @@ -113732,142 +116111,129 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "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", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "resource type", - "name": "resourcetype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "tag key name", - "name": "key", + "description": "the project name of the affinity group", + "name": "project", "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": "the type of the affinity group", + "name": "type", "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": "tag value", - "name": "value", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "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", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { "description": "the type of the template for the virtual machine", @@ -113875,54 +116241,29 @@ "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" } ], "since": "4.18.0" @@ -113932,14 +116273,6 @@ "isasync": true, "name": "deleteTemplate", "params": [ - { - "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": "Necessary if the template's type is system.", "length": 255, @@ -113948,6 +116281,14 @@ "since": "4.20.0", "type": "boolean" }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "Force delete a template.", "length": 255, @@ -113957,25 +116298,25 @@ "type": "boolean" }, { - "description": "the ID of zone of the template", + "description": "the ID of the template", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, "type": "uuid" } ], "response": [ - { - "description": "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", @@ -113996,120 +116337,110 @@ "name": "listNetworkACLLists", "params": [ { - "description": "list network ACLs by VPC ID", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 objects by project; if projectid=-1 lists All VMs", + "description": "list network ACLs by VPC ID", "length": 255, - "name": "projectid", - "related": "", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "Lists network ACL with the specified ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "list network ACLs by specified name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACLs by specified name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list network ACLs by network ID", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "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": "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 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", + "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 network ACLs by network ID", + "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", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" } ], "related": "createNetworkACLList", "response": [ { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, - { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", @@ -114121,11 +116452,15 @@ "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Name of the ACL", + "name": "name", "type": "string" }, - {}, { "description": "is ACL for display to the regular user", "name": "fordisplay", @@ -114136,7 +116471,13 @@ "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" + }, + {} ] }, { @@ -114155,69 +116496,24 @@ ], "related": "copySnapshot,listSnapshots", "response": [ - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, {}, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "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", + "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" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -114226,8 +116522,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -114236,13 +116532,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -114251,47 +116547,91 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "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": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the type of the snapshot", + "name": "snapshottype", "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": "type of the disk volume", - "name": "volumetype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { @@ -114299,49 +116639,45 @@ "name": "datastorestate", "type": "string" }, + {}, { "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", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the snapshot", + "name": "name", "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": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { @@ -114350,39 +116686,44 @@ "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" } ] }, @@ -114418,30 +116759,20 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -114450,8 +116781,19 @@ "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -114460,8 +116802,8 @@ "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -114470,26 +116812,25 @@ "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.4" }, @@ -114508,6 +116849,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", @@ -114520,11 +116866,6 @@ "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", @@ -114537,14 +116878,6 @@ "isasync": false, "name": "deleteSecurityGroup", "params": [ - { - "description": "the project of the security group", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "The ID of the security group. Mutually exclusive with name parameter", "length": 255, @@ -114553,14 +116886,6 @@ "required": false, "type": "uuid" }, - { - "description": "the domain ID of account owning the security group", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "the account of the security group. Must be specified with domain ID", "length": 255, @@ -114574,31 +116899,47 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "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" - } + }, + {} ] }, { @@ -114606,21 +116947,6 @@ "isasync": true, "name": "importVolume", "params": [ - { - "description": "the ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - }, - { - "description": "an optional account for the volume. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the name of the volume. If not set, it will be set to the path of the volume.", "length": 255, @@ -114636,6 +116962,22 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the disk offering linked to the volume", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" + }, { "description": "the path of the volume", "length": 255, @@ -114652,70 +116994,132 @@ "type": "uuid" }, { - "description": "the ID of the disk offering linked to the volume", + "description": "an optional account for the volume. Must be used with domainId.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ + {}, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "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": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the 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 path of the volume", - "name": "path", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "size of the disk volume", @@ -114723,251 +117127,184 @@ "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "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": "cluster id of the volume", "name": "clusterid", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the status of the volume", + "name": "status", "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": "pod name of the volume", - "name": "podname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the state of the disk volume", + "name": "state", + "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "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": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "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": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "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 virtual machine", - "name": "virtualmachineid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -114976,115 +117313,119 @@ "type": "boolean" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the chain info of the volume", + "name": "chaininfo", "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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "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": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "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": "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": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, - {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" } ], "since": "4.19.1" @@ -115095,11 +117436,11 @@ "name": "createTemplate", "params": [ { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,listSnapshots", - "required": false, + "name": "ostypeid", + "related": "addGuestOs", + "required": true, "type": "uuid" }, { @@ -115109,13 +117450,6 @@ "required": false, "type": "string" }, - { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, @@ -115124,26 +117458,9 @@ "type": "boolean" }, { - "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": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "since": "4.19.0", - "type": "string" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "sshkeyenabled", + "name": "isfeatured", "required": false, "type": "boolean" }, @@ -115155,11 +117472,18 @@ "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, + { + "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": "ostypeid", - "related": "addGuestOs", - "required": true, + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", + "required": false, "type": "uuid" }, { @@ -115170,41 +117494,25 @@ "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.19.0", "type": "uuid" }, { - "description": "true if this template is a public template, false otherwise", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "create template for the project", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "projectid", - "related": "", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "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": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, @@ -115216,12 +117524,11 @@ "type": "boolean" }, { - "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "32 or 64 bit", @@ -115231,11 +117538,13 @@ "type": "integer" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "details", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "map" + "since": "4.19.0", + "type": "uuid" }, { "description": "The display text of the template, defaults to the 'name'.", @@ -115243,44 +117552,133 @@ "name": "displaytext", "required": false, "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": "create template for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "true if this template is a public template, false otherwise", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "since": "4.19.0", + "type": "string" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the template ID", - "name": "id", - "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": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { "description": "true if template is sshkey enabled, false otherwise", @@ -115288,54 +117686,39 @@ "type": "boolean" }, { - "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 account name to which the template belongs", - "name": "account", + "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": "checksum of the template", - "name": "checksum", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the status of the template", - "name": "status", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "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", @@ -115348,9 +117731,9 @@ "type": "string" }, { - "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.", @@ -115358,34 +117741,36 @@ "type": "imageformat" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, + {}, + {}, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { "description": "true if the entity/resource has annotations", @@ -115393,34 +117778,74 @@ "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "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 extractable, false otherwise", @@ -115428,14 +117853,14 @@ "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "path of the Domain the template belongs to", @@ -115443,91 +117868,43 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "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 size of the template", + "name": "size", + "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "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": "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 type of the template", + "name": "templatetype", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { @@ -115536,54 +117913,120 @@ "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the project name of the template", + "name": "project", "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 account id to which the template belongs", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Restores an existing stopped or deleted VM using a VM backup", + "isasync": true, + "name": "restoreBackup", + "params": [ { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "ID of the backup", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "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.", + "isasync": true, + "name": "uploadCustomCertificate", + "params": [ + { + "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", + "length": 255, + "name": "id", + "required": false, + "type": "integer" + }, + { + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "message of the certificate upload operation", + "name": "message", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -115594,25 +118037,18 @@ "name": "listDedicatedClusters", "params": [ { - "description": "the ID of the domain associated with the cluster", + "description": "the ID of the cluster", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the cluster", + "description": "the ID of the domain associated with the cluster", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -115623,13 +118059,6 @@ "required": false, "type": "string" }, - { - "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, @@ -115644,31 +118073,24 @@ "related": "", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" - }, - {}, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { "description": "the domain ID of the cluster", "name": "domainid", @@ -115679,79 +118101,38 @@ "name": "accountid", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "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": "uploadCustomCertificate", - "params": [ - { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, - "type": "string" }, { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, - { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", - "required": false, - "type": "integer" - }, - { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "message of the certificate upload operation", - "name": "message", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + } ] }, { @@ -115766,13 +118147,13 @@ "name": "updated_on", "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", @@ -115786,14 +118167,6 @@ "isasync": false, "name": "listTungstenFabricNetwork", "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "the uuid of Tungsten-Fabric network", "length": 255, @@ -115802,18 +118175,18 @@ "type": "string" }, { - "description": "", + "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": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "List by keyword", @@ -115825,45 +118198,53 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", + "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 network name", + "name": "name", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric network name", - "name": "name", + "description": "Tungsten-Fabric network uuid", + "name": "uuid", "type": "string" - }, - {} + } ] }, { @@ -115887,25 +118268,31 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addTrafficMonitor", "response": [ { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, { @@ -115914,25 +118301,19 @@ "type": "string" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the external firewall", - "name": "id", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { @@ -115959,29 +118340,24 @@ "related": "", "response": [ { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, + {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -115990,19 +118366,14 @@ "type": "date" }, { - "description": "the account of the bgp peer", - "name": "account", - "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": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of zone to which the bgp peer belongs to.", @@ -116010,35 +118381,45 @@ "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, - {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, { "description": "additional key/value details of the bgp peer", "name": "details", "type": "map" }, + {}, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" } ], "since": "4.20.0" @@ -116049,20 +118430,18 @@ "name": "updatePortForwardingRule", "params": [ { - "description": "the private end port of the port forwarding rule", + "description": "the private start port of the port forwarding rule", "length": 255, - "name": "privateendport", + "name": "privateport", "required": false, "type": "integer" }, { - "description": "the ID of the port forwarding rule", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "id", - "related": "updatePortForwardingRule", - "required": true, - "since": "4.4", - "type": "uuid" + "name": "privateendport", + "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", @@ -116073,13 +118452,21 @@ "type": "string" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the ID of the port forwarding rule", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": false, + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", "type": "uuid" }, + { + "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -116097,59 +118484,20 @@ "type": "string" }, { - "description": "the private start port of the port forwarding rule", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "privateport", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "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 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 ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -116158,29 +118506,23 @@ "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", + "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 public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, - {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -116188,23 +118530,23 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "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": "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" }, { @@ -116212,11 +118554,6 @@ "name": "key", "type": "string" }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, { "description": "tag value", "name": "value", @@ -116228,8 +118565,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -116238,27 +118575,78 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, { "description": "the VM ID for the port forwarding rule", "name": "virtualmachineid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { "description": "the state of the rule", "name": "state", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -116268,11 +118656,11 @@ "name": "associateIpAddress", "params": [ { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "description": "IP Address to be associated", "length": 255, - "name": "isportable", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { "description": "Deploy VM for the project", @@ -116283,35 +118671,34 @@ "type": "uuid" }, { - "description": "the VPC you want the IP address to be associated with", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "region ID from where portable IP is to be associated.", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "regionid", - "related": "", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "IP Address to be associated", + "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": "ipaddress", + "name": "isportable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "the account to associate with this IP address", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "the ID of the availability zone you want to acquire an public IP address from", @@ -116322,25 +118709,26 @@ "type": "uuid" }, { - "description": "the ID of the domain to associate with this IP address", + "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 account to associate with this IP address", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "account", + "name": "regionid", + "related": "", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The network this IP address should be associated to.", + "description": "the ID of the domain to associate with this IP address", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" } @@ -116348,18 +118736,13 @@ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -116367,110 +118750,58 @@ "name": "issystem", "type": "boolean" }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, { "description": "true if this ip is for static nat, false otherwise", "name": "isstaticnat", "type": "boolean" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "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 project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - {}, { "description": "virtual machine id the ip address is assigned to", "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - {}, - { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { "description": "VPC name the ip belongs to", "name": "vpcname", "type": "string" }, - { - "description": "public IP address id", - "name": "id", - "type": "string" - }, - { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "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": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -116479,61 +118810,56 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "resource type", - "name": "resourcetype", + "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" }, { - "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 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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "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": "public IP address", + "name": "ipaddress", "type": "string" }, { @@ -116542,38 +118868,53 @@ "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "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", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { @@ -116582,14 +118923,19 @@ "type": "boolean" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "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": "the physical network this belongs to", @@ -116597,8 +118943,50 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + {}, + { + "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 ID of the Network where ip belongs to", + "name": "networkid", + "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": "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" } ] @@ -116625,23 +119013,23 @@ ], "related": "", "response": [ + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -116659,27 +119047,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -116690,11 +119078,27 @@ "params": [], "related": "listAlerts", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the alert", + "name": "name", + "type": "string" + }, { "description": "description of the alert", "name": "description", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the date and time the alert was sent", "name": "sent", @@ -116705,27 +119109,11 @@ "name": "type", "type": "short" }, - { - "description": "the name of the alert", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "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" } ] }, @@ -116734,21 +119122,6 @@ "isasync": true, "name": "createNetworkACL", "params": [ - { - "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": "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 ending port of ACL", "length": 255, @@ -116764,20 +119137,12 @@ "type": "integer" }, { - "description": "scl entry action, allow or deny", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "action", - "required": false, + "name": "protocol", + "required": true, "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 CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, @@ -116786,11 +119151,11 @@ "type": "list" }, { - "description": "type of the ICMP message being sent", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "icmptype", + "name": "reason", "required": false, - "type": "integer" + "type": "string" }, { "description": "The network of the VM the ACL will be created for", @@ -116808,18 +119173,19 @@ "type": "integer" }, { - "description": "the starting port of ACL", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "startport", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "type of the ICMP message being sent", "length": 255, - "name": "reason", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", @@ -116827,452 +119193,126 @@ "name": "traffictype", "required": false, "type": "string" - } - ], - "related": "updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "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": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", - "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 account for the ssh key. Must be used with domainId.", + "description": "scl entry action, allow or deny", "length": 255, - "name": "account", + "name": "action", "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": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "the starting port of ACL", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "startport", "required": false, - "type": "uuid" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "an optional project for the ssh key", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "projectid", - "related": "", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "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" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "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", - "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": "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": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + {}, + { + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -117281,28 +119321,28 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "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" }, { @@ -117311,167 +119351,107 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "type": "list" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the starting port of ACL's port range", + "name": "startport", "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 alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "the account associated with the virtual machine", + "description": "an optional account for the ssh key. 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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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": "the name of the virtual machine", - "name": "name", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -117479,53 +119459,73 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { "description": "the broadcast uri of the nic", "name": "broadcasturi", "type": "string" }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, { "description": "the traffic type of the nic", "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -117534,18 +119534,33 @@ "type": "integer" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -117554,8 +119569,8 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -117564,92 +119579,118 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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" }, - { - "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "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": "device ID of the root volume", - "name": "rootdeviceid", - "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -117658,37 +119699,173 @@ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + {}, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "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" }, { @@ -117702,18 +119879,13 @@ "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 project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -117721,16 +119893,6 @@ "name": "name", "type": "string" }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, { "description": "the description of the affinity group", "name": "description", @@ -117742,138 +119904,100 @@ "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", + "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" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "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 domain ID of the security group", - "name": "domainid", + "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 egress rules associated with the security group", + "name": "egressrule", "response": [ { - "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": "tag key name", - "name": "key", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "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", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the 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": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -117885,13 +120009,8 @@ "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" }, { @@ -117905,13 +120024,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -117920,132 +120039,159 @@ "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": "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", "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" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "tag value", + "name": "value", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -118054,36 +120200,41 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -118092,40 +120243,282 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + {}, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + {}, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" } ] }, @@ -118135,19 +120528,18 @@ "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": "UUID of POD, where the IP range belongs to.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "vlan", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The ending IP address.", @@ -118157,35 +120549,36 @@ "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" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ], "since": "4.11.0.0" @@ -118196,100 +120589,84 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "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.", + "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", "length": 255, - "name": "checksum", + "name": "directdownload", "required": false, - "type": "string" + "since": "4.18.2", + "type": "boolean" }, { - "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "arch", + "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, - "since": "4.20", "type": "string" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "mincpunumber", + "name": "minmemory", "required": true, "type": "integer" }, { - "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 URL of the binaries ISO for Kubernetes supported version", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "url", - "required": false, + "name": "semanticversion", + "required": true, "type": "string" }, { - "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "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": "directdownload", + "name": "checksum", "required": false, - "since": "4.18.2", - "type": "boolean" - }, - { - "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": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "minmemory", + "name": "mincpunumber", "required": true, "type": "integer" } ], "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" - }, - { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" - }, - { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" - }, { "description": "the 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": "Name of the Kubernetes supported version", "name": "name", @@ -118300,36 +120677,40 @@ "name": "zonename", "type": "string" }, - {}, + { + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + }, { "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { "description": "the name of the binaries ISO for Kubernetes supported version", @@ -118337,20 +120718,37 @@ "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" - } + }, + { + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + {} ] }, { @@ -118366,14 +120764,6 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of the ISO for the virtual machine", - "length": 255, - "name": "isoid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "type": "uuid" - }, { "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", "length": 255, @@ -118388,70 +120778,129 @@ "name": "userdatapolicy", "required": false, "type": "string" + }, + { + "description": "the ID of the ISO for the virtual machine", + "length": 255, + "name": "isoid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "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": "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 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 key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, - {}, { - "description": "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the account id to which the template belongs", @@ -118459,247 +120908,191 @@ "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "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": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, - {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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 template display text", - "name": "displaytext", + "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", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "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": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "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 processor bit size", - "name": "bits", - "type": "int" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", - "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", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { "description": "true if the reset password feature is enabled, false otherwise", @@ -118707,28 +121100,33 @@ "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" } ], @@ -118740,71 +121138,71 @@ "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "region ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "regionid", - "related": "", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "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": "region ID", "length": 255, - "name": "isrecursive", + "name": "regionid", + "related": "", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "page", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomains", + "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": "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)", @@ -118814,39 +121212,18 @@ "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -118854,15 +121231,10 @@ "name": "domainpath", "type": "string" }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, {}, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -118870,68 +121242,53 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "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 project name of the load balancer", - "name": "project", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "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 public ip address", - "name": "publicip", + "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 load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -118940,28 +121297,18 @@ "type": "boolean" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -118969,43 +121316,38 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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" }, { @@ -119014,60 +121356,90 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "list" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "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" } ], "type": "list" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the domain of the load balancer rule", + "name": "domain", "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 project id of the load balancer", + "name": "projectid", + "type": "string" }, { "description": "session persistence method used for the global load balancer", @@ -119078,45 +121450,32 @@ "description": "GSLB service type", "name": "gslbservicetype", "type": "string" - } - ] - }, - { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", - "params": [ + }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "global load balancer rule ID", + "name": "id", + "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the project name of the load balancer", + "name": "project", + "type": "string" } ] }, @@ -119136,27 +121495,66 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", + "params": [ + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -119175,20 +121573,19 @@ ], "related": "", "response": [ - {}, { - "description": "the id of the container cluster", - "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": "Name of the container cluster", + "name": "name", "type": "string" }, { - "description": "Name of the container cluster", - "name": "name", + "description": "the id of the container cluster", + "name": "id", "type": "string" }, { @@ -119198,10 +121595,11 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -119225,22 +121623,22 @@ "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" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {} ] }, { @@ -119258,17 +121656,12 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -119279,6 +121672,11 @@ "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.9.0" @@ -119298,26 +121696,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": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -119327,6 +121725,28 @@ "isasync": false, "name": "listInternalLoadBalancerVMs", "params": [ + { + "description": "the ID of the Internal LB VM", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the state of the Internal LB VM", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the Pod ID of the Internal LB VM", "length": 255, @@ -119351,11 +121771,12 @@ "type": "boolean" }, { - "description": "the state of the Internal LB VM", + "description": "the host ID of the Internal LB VM", "length": 255, - "name": "state", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "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.", @@ -119365,42 +121786,34 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "account", + "name": "fetchhealthcheckresults", "required": false, - "type": "string" + "since": "4.14", + "type": "boolean" }, { - "description": "the host ID of the Internal LB VM", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "forvpc", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the Internal LB VM", + "description": "list by network id", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the name of the Internal LB VM", @@ -119410,84 +121823,99 @@ "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fetchhealthcheckresults", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "list by network id", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "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 by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List Internal LB VMs by VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "projectid", + "related": "", "required": false, "type": "uuid" - }, - { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" } ], "related": "listRouters", "response": [ { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "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 domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "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": "result of the health check", + "name": "success", + "type": "boolean" + }, { "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 type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { "description": "detailed response generated on running health check", @@ -119498,28 +121926,18 @@ "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" } ], "type": "list" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -119528,89 +121946,18 @@ "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", + "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": "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 guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -119619,93 +121966,89 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the network domain for the router", + "name": "networkdomain", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, + {}, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -119713,58 +122056,53 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "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", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -119773,9 +122111,9 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { "description": "name of the vpc to which the nic belongs", @@ -119783,122 +122121,187 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 name of the corresponding network", - "name": "networkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the link local IP address for the router", "name": "linklocalip", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "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 Pod name for the router", + "name": "podname", "type": "string" }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, { "description": "the ID of the corresponding public network", "name": "publicnetworkid", "type": "string" }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, { "description": "the account associated with the router", "name": "account", "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 ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + {}, { "description": "the second DNS for the router", "name": "dns2", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { @@ -119912,8 +122315,8 @@ "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -119922,14 +122325,14 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" } ] }, @@ -119939,24 +122342,32 @@ "name": "listCiscoVnmcResources", "params": [ { - "description": "Cisco VNMC resource ID", + "description": "the Physical Network ID", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -119966,14 +122377,6 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", @@ -119989,12 +122392,12 @@ {}, {}, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -120021,9 +122424,20 @@ "related": "", "response": [ { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { @@ -120031,10 +122445,9 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { @@ -120042,26 +122455,16 @@ "name": "status", "type": "status" }, - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" - }, {}, { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { "description": "List of migrations", "name": "migrations", "type": "list" - }, - { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" } ], "since": "4.19.0" @@ -120081,18 +122484,18 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -120111,13 +122514,6 @@ "isasync": false, "name": "uploadResourceIcon", "params": [ - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, { "description": "type of the resource", "length": 255, @@ -120131,30 +122527,37 @@ "name": "base64image", "required": true, "type": "string" + }, + { + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" } ], "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" } ], "since": "4.16.0.0" @@ -120183,18 +122586,8 @@ "related": "listKubernetesSupportedVersions", "response": [ { - "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", - "name": "mincpunumber", - "type": "integer" - }, - { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { @@ -120203,9 +122596,14 @@ "type": "integer" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { "description": "the id of the zone in which Kubernetes supported version is available", @@ -120213,60 +122611,70 @@ "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, - {}, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "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": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" + }, + { + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, + {}, { "description": "the enabled or disabled state of the Kubernetes supported version", "name": "state", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" } ] @@ -120286,28 +122694,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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], "since": "4.20.0" }, @@ -120334,21 +122742,31 @@ ], "related": "listGuestNetworkIpv6Prefixes", "response": [ - { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, { "description": " date when this IPv6 prefix was created.", "name": "created", "type": "date" }, + { + "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", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, { "description": "id of zone to which the IPv6 prefix belongs to.", "name": "zoneid", @@ -120360,27 +122778,17 @@ "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" }, - {}, { "description": "count of the total IPv6 subnets for the prefix.", "name": "totalsubnets", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "integer" }, - { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" - } + {}, + {} ], "since": "4.17.0.0" }, @@ -120390,11 +122798,11 @@ "name": "createRole", "params": [ { - "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", @@ -120405,11 +122813,11 @@ "type": "uuid" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "ispublic", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The description of the role", @@ -120434,20 +122842,24 @@ "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { "description": "the description of the role", @@ -120455,26 +122867,22 @@ "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", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", "type": "boolean" }, { - "description": "the name of the role", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the role", + "name": "state", "type": "string" - } + }, + {} ], "since": "4.9.0" }, @@ -120484,18 +122892,19 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "the name of the volume/template/iso", + "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": "name", - "required": true, - "type": "string" + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { @@ -120506,17 +122915,18 @@ "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Image store uuid", + "description": "the name of the volume/template/iso", "length": 255, - "name": "imagestoreuuid", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -120527,37 +122937,46 @@ "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "Image store uuid", "length": 255, - "name": "projectid", - "related": "", + "name": "imagestoreuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "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, "type": "uuid" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "format", "required": true, - "type": "uuid" + "type": "string" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ + {}, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, { "description": "the timestamp after which the signature expires", "name": "expires", "type": "string" }, + { + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, { "description": "signature to be sent in the POST request.", "name": "signature", @@ -120565,13 +122984,8 @@ }, {}, { - "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", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { @@ -120580,16 +122994,10 @@ "type": "integer" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.6.0" }, @@ -120598,22 +123006,6 @@ "isasync": true, "name": "updateAutoScaleVmProfile", "params": [ - { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" - }, { "description": "the ID of the autoscale vm profile", "length": 255, @@ -120623,20 +123015,28 @@ "type": "uuid" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "counterparam", + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", "required": false, + "since": "4.18.1", "type": "map" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "the ID of the userdata", @@ -120648,12 +123048,12 @@ "type": "uuid" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "otherdeployparams", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "map" }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", @@ -120663,28 +123063,29 @@ "type": "integer" }, { - "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", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "otherdeployparams", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "since": "4.18.0", - "type": "map" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "customid", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.4", - "type": "string" + "since": "4.18.0", + "type": "uuid" }, { "description": "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", @@ -120693,54 +123094,57 @@ "required": false, "since": "4.18.0", "type": "string" + }, + { + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, + "type": "map" } ], "related": "listAutoScaleVmProfiles", "response": [ + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", "name": "otherdeployparams", "type": "map" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "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", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, + {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -120748,11 +123152,9 @@ "name": "project", "type": "string" }, - {}, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { @@ -120761,49 +123163,55 @@ "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "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": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "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 account owning the instance group", - "name": "account", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "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 account owning the instance group", + "name": "account", "type": "string" } ] @@ -120825,31 +123233,35 @@ "related": "", "response": [ { - "description": "the project name of the vm group", - "name": "project", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "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 name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, - {}, { "description": "the project id of the vm group", "name": "projectid", @@ -120861,18 +123273,13 @@ "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "the public ip address", - "name": "publicip", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -120881,14 +123288,9 @@ "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 domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { "description": "is group for display to the regular user", @@ -120896,80 +123298,86 @@ "type": "boolean" }, { - "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": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "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 autoscale vm group ID", - "name": "id", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "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 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 load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the 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 account owning the vm group", - "name": "account", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" }, {}, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "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" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -120978,6 +123386,13 @@ "isasync": false, "name": "listGuestNetworkIpv6Prefixes", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "UUID of the IPv6 prefix.", "length": 255, @@ -121007,59 +123422,52 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, - { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, - {}, { "description": "id of the guest IPv6 prefix", "name": "id", "type": "string" }, + {}, { "description": "count of the available IPv6 subnets for the prefix.", "name": "availablesubnets", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": " date when this IPv6 prefix was created.", "name": "created", @@ -121080,14 +123488,6 @@ "required": true, "type": "string" }, - { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", - "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, { "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, @@ -121095,18 +123495,22 @@ "related": "updateGuestOsMapping", "required": true, "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": "", "response": [ + {}, { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { @@ -121115,25 +123519,23 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "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": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { @@ -121145,7 +123547,13 @@ "description": "the ID of the Guest OS type", "name": "ostypeid", "type": "string" - } + }, + { + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -121171,6 +123579,7 @@ } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -121186,13 +123595,12 @@ "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -121201,11 +123609,11 @@ "name": "updateHostPassword", "params": [ { - "description": "the username for the host/cluster", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "update_passwd_on_host", + "required": false, + "type": "boolean" }, { "description": "the new password for the host/cluster", @@ -121214,13 +123622,6 @@ "required": true, "type": "string" }, - { - "description": "if the password should also be updated on the hosts", - "length": 255, - "name": "update_passwd_on_host", - "required": false, - "type": "boolean" - }, { "description": "the host ID", "length": 255, @@ -121236,15 +123637,16 @@ "related": "addCluster,updateCluster", "required": false, "type": "uuid" + }, + { + "description": "the username for the host/cluster", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -121252,15 +123654,21 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -121269,16 +123677,16 @@ "name": "createPortableIpRange", "params": [ { - "description": "the netmask of the portable IP range", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "netmask", + "name": "endip", "required": true, "type": "string" }, { - "description": "the gateway for the portable IP range", + "description": "the netmask of the portable IP range", "length": 255, - "name": "gateway", + "name": "netmask", "required": true, "type": "string" }, @@ -121290,12 +123698,19 @@ "type": "string" }, { - "description": "the ending IP address in the portable IP range", + "description": "the gateway for the portable IP range", "length": 255, - "name": "endip", + "name": "gateway", "required": true, "type": "string" }, + { + "description": "VLAN id, if not specified defaulted to untagged", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, { "description": "Id of the Region", "length": 255, @@ -121303,32 +123718,45 @@ "related": "", "required": true, "type": "integer" - }, - { - "description": "VLAN id, if not specified defaulted to untagged", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" } ], "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": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, { "description": "the end ip of the portable IP range", "name": "endip", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the gateway of the VLAN IP range", "name": "gateway", "type": "string" }, + { + "description": "the start ip of the portable IP range", + "name": "startip", + "type": "string" + }, + { + "description": "portable IP range ID", + "name": "id", + "type": "string" + }, { "description": "the ID or VID of the VLAN.", "name": "vlan", @@ -121336,19 +123764,14 @@ }, {}, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { "description": "the ID of the Network where ip belongs to", @@ -121356,44 +123779,44 @@ "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "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": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, { "description": "the ID of the zone the public IP address belongs to", "name": "zoneid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, { "description": "the account ID the portable IP address is associated with", "name": "accountid", "type": "string" + }, + { + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" } ], "type": "list" @@ -121402,21 +123825,6 @@ "description": "the netmask of the VLAN IP range", "name": "netmask", "type": "string" - }, - { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - { - "description": "portable IP range ID", - "name": "id", - "type": "string" - }, - { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" } ], "since": "4.2.0" @@ -121427,10 +123835,17 @@ "name": "deleteWebhookDelivery", "params": [ { - "description": "The ID of the Webhook delivery", + "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": "id", - "related": "", + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook", "required": false, "type": "uuid" }, @@ -121442,54 +123857,272 @@ "required": false, "type": "uuid" }, + { + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be considered.", "length": 255, "name": "startdate", "required": false, "type": "date" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The ID of the Webhook", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.20.0" + }, + { + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", + "params": [ + { + "description": "hypervisor type of the cluster", "length": 255, - "name": "webhookid", - "related": "createWebhook", + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "clustertype", "required": false, + "type": "string" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, "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": "whether this cluster is managed by cloudstack", "length": 255, - "name": "enddate", + "name": "managedstate", "required": false, - "type": "date" + "type": "string" + }, + { + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" } ], + "related": "addCluster", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, {}, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, {} - ], - "since": "4.20.0" + ] }, { "description": "Lists the VMs in a VMware Datacenter", @@ -121504,16 +124137,16 @@ "type": "string" }, { - "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": "Name of VMware datacenter.", + "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": "datacentername", + "name": "vcenter", "required": false, "type": "string" }, @@ -121525,9 +124158,16 @@ "type": "integer" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "vcenter", + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "Name of the host on vCenter. Must be set along with the instancename parameter", + "length": 255, + "name": "hostname", "required": false, "type": "string" }, @@ -121547,60 +124187,35 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "listUnmanagedInstances", - "response": [ - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" }, { - "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": "listUnmanagedInstances", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" }, - {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -121608,18 +124223,18 @@ "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -121628,98 +124243,93 @@ "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "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 gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ip address of the nic", + "name": "ipaddress", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -121728,23 +124338,28 @@ "type": "list" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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", + "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -121753,31 +124368,37 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, + {}, { "description": "the ID of the host to which virtual machine belongs", "name": "hostid", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", + "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 name of the host to which virtual machine belongs", - "name": "hostname", + "description": "indicates the boot mode", + "name": "bootmode", "type": "string" }, { @@ -121785,13 +124406,13 @@ "name": "disk", "response": [ { - "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": "datastorepath", + "name": "datastorename", "type": "string" }, { @@ -121801,7 +124422,7 @@ }, { "description": "the controller of the disk", - "name": "datastorename", + "name": "datastorepath", "type": "string" }, { @@ -121814,6 +124435,11 @@ "name": "controller", "type": "string" }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, { "description": "the capacity of the disk in bytes", "name": "capacity", @@ -121825,328 +124451,131 @@ "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" + "description": "the position of the disk", + "name": "position", + "type": "integer" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" - } - ] - }, - { - "description": "Updates an existing cluster", - "isasync": false, - "name": "updateCluster", - "params": [ - { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the cluster name", - "length": 255, + "description": "the name of the cluster to which virtual machine belongs", "name": "clustername", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - } - ], - "related": "addCluster", - "response": [ - { - "description": "the capacity of the Cluster", - "name": "capacity", - "response": [ - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - } - ], - "type": "list" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "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 cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - {}, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "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": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, + {}, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" } ] }, { - "description": "List profile in ucs manager", + "description": "Lists storage providers.", "isasync": false, - "name": "listUcsProfiles", + "name": "listStorageProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the id for the ucs manager", + "description": "List by keyword", "length": 255, - "name": "ucsmanagerid", - "related": "", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "the type of storage provider: either primary or image", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "type", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "ucs profile dn", - "name": "ucsdn", + "description": "the type of the storage provider: primary or image provider", + "name": "type", "type": "string" - } + }, + {}, + { + "description": "the name of the storage provider", + "name": "name", + "type": "string" + }, + {} ] }, { - "description": "Lists storage providers.", + "description": "List profile in ucs manager", "isasync": false, - "name": "listStorageProviders", + "name": "listUcsProfiles", "params": [ - { - "description": "the type of storage provider: either primary or image", - "length": 255, - "name": "type", - "required": true, - "type": "string" - }, { "description": "", "length": 255, @@ -122161,6 +124590,14 @@ "required": false, "type": "string" }, + { + "description": "the id for the ucs manager", + "length": 255, + "name": "ucsmanagerid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -122171,23 +124608,18 @@ ], "related": "", "response": [ + {}, { "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" - }, {}, { - "description": "the name of the storage provider", - "name": "name", + "description": "ucs profile dn", + "name": "ucsdn", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -122211,12 +124643,6 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, {}, { "description": "the api key of the registered user", @@ -122228,6 +124654,17 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "whether api key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" + }, + {}, { "description": "the secret key of the registered user", "name": "secretkey", @@ -122273,14 +124710,25 @@ ], "related": "", "response": [ + {}, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "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 domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -122288,12 +124736,57 @@ "name": "gslblbmethod", "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", + "type": "string" + }, { "description": "the project name of the load balancer", "name": "project", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + {}, { "description": "session persistence method used for the global load balancer", "name": "gslbstickysessionmethodname", @@ -122304,28 +124797,8 @@ "name": "loadbalancerrule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -122333,33 +124806,18 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -122368,13 +124826,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -122383,8 +124841,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -122393,51 +124851,51 @@ "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 value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "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 project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -122446,8 +124904,23 @@ "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 id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "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 load balancer rule ID", + "name": "id", "type": "string" }, { @@ -122456,52 +124929,78 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "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 name of the load balancer", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ], "type": "list" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, + } + ] + }, + { + "description": "Allow or disallow a user to use SAML SSO", + "isasync": false, + "name": "authorizeSamlSso", + "params": [ { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "User uuid", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "The Identity Provider ID the user is allowed to get single signed on from", + "length": 255, + "name": "entityid", + "related": "listIdps", + "required": false, "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, + "description": "If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.", + "length": 255, + "name": "enable", + "required": true, + "type": "boolean" + } + ], + "response": [ { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -122515,20 +125014,12 @@ "type": "integer" }, { - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - } + {}, + {} ] }, { @@ -122536,13 +125027,6 @@ "isasync": false, "name": "listHostTags", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -122556,40 +125040,47 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "the host ID of the host tag", - "name": "hostid", - "type": "long" - }, {}, { - "description": "the ID of the host tag", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "true if the host tag is implicit", + "name": "isimplicit", + "type": "boolean" + }, + {}, { "description": "the name of the host tag", "name": "name", "type": "string" }, + { + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "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" } ] @@ -122599,6 +125090,14 @@ "isasync": true, "name": "addGuestOs", "params": [ + { + "description": "ID of Guest OS category", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": true, + "type": "uuid" + }, { "description": "Optional name for Guest OS", "length": 255, @@ -122606,6 +125105,13 @@ "required": false, "type": "string" }, + { + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" + }, { "description": "Map of (key/value pairs)", "length": 255, @@ -122619,44 +125125,20 @@ "name": "osdisplayname", "required": true, "type": "string" - }, - { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "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": "", "response": [ - { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" - }, - {}, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, { "description": "the name of the OS type", "name": "name", "type": "string" }, + {}, + {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { @@ -122664,12 +125146,6 @@ "name": "jobid", "type": "string" }, - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, - {}, { "description": "is the guest OS visible for the users", "name": "fordisplay", @@ -122681,9 +125157,24 @@ "type": "integer" }, { - "description": "the name/description of the OS type", - "name": "description", + "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 category", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" } ], "since": "4.4.0" @@ -122700,13 +125191,6 @@ "required": false, "type": "string" }, - { - "description": "the id of the entity to annotate", - "length": 255, - "name": "entityid", - "required": false, - "type": "string" - }, { "description": "the annotation is visible for admins only", "length": 255, @@ -122721,30 +125205,68 @@ "name": "annotation", "required": false, "type": "string" + }, + { + "description": "the id of the entity to annotate", + "length": 255, + "name": "entityid", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" }, { "description": "the name of the entity to which this annotation pertains", "name": "entityname", "type": "string" }, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, { "description": "the (uu)id of the entity to which this annotation pertains", "name": "entityid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the type of the annotated entity", "name": "entitytype", "type": "string" }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "True if the annotation is available for admins only", "name": "adminsonly", @@ -122755,40 +125277,45 @@ "name": "id", "type": "string" }, - {}, - {}, + {} + ], + "since": "4.11" + }, + { + "description": "Returns list of discovered SAML Identity Providers", + "isasync": false, + "name": "listIdps", + "params": [], + "related": "", + "response": [ { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "The IdP Entity ID", + "name": "id", + "type": "string" }, + {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The IdP Organization Name", + "name": "orgName", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The IdP Organization URL", + "name": "orgUrl", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11" + {} + ] }, { "description": "Creates new NS Vpx", @@ -122796,18 +125323,10 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the service offering for the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, @@ -122820,10 +125339,18 @@ "type": "uuid" }, { - "description": "availability zone for the virtual machine", + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" } @@ -122831,35 +125358,29 @@ "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "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": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { "description": "device id of the netscaler load balancer", @@ -122867,18 +125388,23 @@ "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "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", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -122887,8 +125413,8 @@ "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { @@ -122897,25 +125423,26 @@ "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, {}, { - "description": "name of the provider", - "name": "provider", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -122941,18 +125468,18 @@ "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "synchronization", + "name": "sync", "type": "string" }, { - "description": "the id of the volume", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "name": "name", "type": "string" }, { @@ -122961,21 +125488,21 @@ "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "compression", + "name": "compression", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the volume", + "name": "id", + "type": "string" }, { - "description": "synchronization", - "name": "sync", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -122983,14 +125510,6 @@ "isasync": true, "name": "addBaremetalPxeKickStartServer", "params": [ - { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, { "description": "URL of the external pxe device", "length": 255, @@ -122999,69 +125518,76 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "tftpdir", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "type of pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "pxeservertype", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Pod Id", "length": 255, - "name": "password", + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "type of pxe device", + "length": 255, + "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": "the Physical Network ID", "length": 255, - "name": "tftpdir", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", + "description": "url", + "name": "url", "type": "string" }, + {}, { - "description": "url", - "name": "url", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of ", + "name": "id", "type": "string" }, - {}, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -123069,9 +125595,10 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -123081,13 +125608,6 @@ "isasync": false, "name": "listNiciraNvpDevices", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the Physical Network ID", "length": 255, @@ -123097,18 +125617,18 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "nicira nvp device ID", @@ -123117,38 +125637,42 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "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": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", - "type": "string" - }, - { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, + {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -123156,23 +125680,26 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "device name", + "name": "niciradevicename", + "type": "string" + }, { "description": "the transport zone Uuid", "name": "transportzoneuuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { "description": "name of the provider", "name": "provider", "type": "string" - }, - {}, - {} + } ] }, { @@ -123180,20 +125707,6 @@ "isasync": false, "name": "listAlerts", "params": [ - { - "description": "list by alert type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list by alert name", "length": 255, @@ -123205,10 +125718,17 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "list by alert type", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, { "description": "the ID of the alert", "length": 255, @@ -123217,10 +125737,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" } @@ -123233,36 +125760,36 @@ "name": "id", "type": "string" }, - { - "description": "description of the alert", - "name": "description", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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": "the name of the alert", - "name": "name", + "description": "description of the alert", + "name": "description", "type": "string" }, - {}, { "description": "the date and time the alert was sent", "name": "sent", "type": "date" + }, + {}, + { + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -123272,149 +125799,148 @@ "name": "deployVirtualMachine", "params": [ { - "description": "used to specify the vApp properties.", + "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": "properties", + "name": "securitygroupids", + "related": "", "required": false, - "since": "4.15", - "type": "map" + "type": "list" }, { - "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 field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "securitygroupnames", - "related": "", + "name": "customid", "required": false, - "type": "list" + "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "details", + "name": "size", "required": false, - "since": "4.3", - "type": "map" + "type": "long" }, { - "description": "availability zone for the virtual machine", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "dynamicscalingenabled", + "name": "startvm", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "the ipv6 address for default vm's network", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "ip6address", + "name": "displayvm", "required": false, - "type": "string" + "since": "4.2", + "type": "boolean" }, { - "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 Userdata", "length": 255, - "name": "overridediskofferingid", + "name": "userdataid", "related": "", "required": false, - "since": "4.17", + "since": "4.18", "type": "uuid" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "size", + "name": "nicmultiqueuenumber", "required": false, - "type": "long" + "since": "4.18", + "type": "integer" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "rootdisksize", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.4", - "type": "long" + "type": "list" }, { - "description": "an optional user generated name for the virtual machine", + "description": "the ip address for default vm's network", "length": 255, - "name": "displayname", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "the mac address for default vm's network", + "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": "macaddress", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "password", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.19.0.0", + "type": "string" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "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": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "list" + "type": "map" }, { - "description": "the ip address for default vm's network", + "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": "ipaddress", + "name": "iothreadsenabled", "required": false, - "type": "string" + "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": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "bootmode", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "Controls specific policies on IO", + "description": "an optional group for the virtual machine", "length": 255, - "name": "iodriverpolicy", + "name": "group", "required": false, "type": "string" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", "required": false, "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "userdatadetails", "required": false, + "since": "4.18", "type": "map" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "host name for the virtual machine", "length": 255, - "name": "password", + "name": "name", "required": false, - "since": "4.19.0.0", "type": "string" }, { @@ -123426,107 +125952,113 @@ "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": "the mac address for default vm's network", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "macaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "", "required": false, - "since": "4.12", - "type": "string" + "type": "list" }, { - "description": "an optional group for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "group", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "displayvm", + "name": "nicpackedvirtqueuesenabled", "required": false, - "since": "4.2", + "since": "4.18", "type": "boolean" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "bootintosetup", + "name": "displayname", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "keypair", + "name": "deploymentplanner", "required": false, + "since": "4.4", "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", "length": 255, - "name": "nicmultiqueuenumber", + "name": "iptonetworklist", "required": false, - "since": "4.18", - "type": "integer" + "type": "map" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "keypairs", + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.17", - "type": "list" + "since": "4.13", + "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "deploymentplanner", + "name": "affinitygroupnames", + "related": "", "required": false, - "since": "4.4", - "type": "string" + "type": "list" }, { - "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": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "keyboard", + "name": "dynamicscalingenabled", "required": false, - "type": "string" + "since": "4.16", + "type": "boolean" }, { - "description": "the ID of the Userdata", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "userdataid", - "related": "", + "name": "keypair", "required": false, - "since": "4.18", - "type": "uuid" + "type": "string" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "copyimagetags", "required": false, "since": "4.13", - "type": "uuid" + "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", - "length": 255, - "name": "nicnetworklist", + "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.15", - "type": "map" + "since": "4.12", + "type": "string" + }, + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "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", @@ -123537,100 +126069,101 @@ "type": "map" }, { - "description": "host name for the virtual machine", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "name", + "name": "keyboard", "required": false, "type": "string" }, { - "description": "Enable packed virtqueues or not.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "account", "required": false, - "since": "4.18", - "type": "boolean" + "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": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "iothreadsenabled", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins 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": "customid", + "name": "bootmode", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "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": "boottype", + "name": "rootdisksize", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "keypairs", "required": false, + "since": "4.17", "type": "list" }, { - "description": "Deploy vm for the project", - "length": 255, - "name": "projectid", - "related": "", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, - "type": "uuid" + "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": "Controls specific policies on IO", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "iodriverpolicy", "required": false, - "type": "list" + "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": "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": "iptonetworklist", + "name": "boottype", "required": false, - "type": "map" + "since": "4.14.0.0", + "type": "string" }, { - "description": "destination Host 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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "details", "required": false, - "type": "uuid" + "since": "4.3", + "type": "map" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "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": "startvm", + "name": "nicnetworklist", "required": false, - "type": "boolean" + "since": "4.15", + "type": "map" }, { - "description": "the ID of the template for the virtual machine", + "description": "used to specify the vApp properties.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "properties", + "required": false, + "since": "4.15", + "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": "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": "affinitygroupnames", + "name": "affinitygroupids", "related": "", "required": false, "type": "list" @@ -123643,107 +126176,46 @@ "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", - "length": 255, - "name": "copyimagetags", - "required": false, - "since": "4.13", - "type": "boolean" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "Deploy vm for the project", "length": 255, - "name": "userdatadetails", + "name": "projectid", + "related": "", "required": false, - "since": "4.18", - "type": "map" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "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": "account", + "name": "overridediskofferingid", + "related": "", "required": false, - "type": "string" + "since": "4.17", + "type": "uuid" } ], "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 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 template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -123751,134 +126223,35 @@ "name": "rootdeviceid", "type": "long" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "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 virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -123887,143 +126260,24 @@ "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - {}, - {}, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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": "publicip", "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 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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "Guest vm Boot Mode", @@ -124031,18 +126285,8 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -124050,38 +126294,23 @@ "name": "nic", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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", + "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -124090,68 +126319,73 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "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 IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the type of the nic", + "name": "type", "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": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -124160,9 +126394,9 @@ "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 ID of the nic", @@ -124170,24 +126404,24 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { "description": "the isolation uri of the nic", @@ -124195,37 +126429,51 @@ "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 extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "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", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -124234,88 +126482,191 @@ "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": "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 password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ssh key-pairs", + "name": "keypairs", "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "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 template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { @@ -124323,18 +126674,18 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -124343,56 +126694,71 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "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 value", - "name": "value", + "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" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "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": "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 backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -124400,62 +126766,159 @@ "name": "publicipid", "type": "string" }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, { "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "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": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the project name of the group", - "name": "project", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the 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" }, { @@ -124468,15 +126931,40 @@ "name": "endport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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", @@ -124497,59 +126985,69 @@ "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": "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" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the 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" } ], "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 name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "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" }, { @@ -124557,38 +127055,38 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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 project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -124597,33 +127095,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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", @@ -124634,116 +127122,44 @@ "name": "icmptype", "type": "integer" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "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": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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 name of the security group", - "name": "name", - "type": "string" - }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, { "description": "the domain name of the security group", "name": "domain", @@ -124753,19 +127169,135 @@ "description": "the project id of the group", "name": "projectid", "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 state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + {}, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "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": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" } ] }, @@ -124775,82 +127307,77 @@ "name": "listVolumes", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "list volumes by disk offering", "length": 255, - "name": "tags", + "name": "diskofferingid", + "related": "", "required": false, - "type": "map" + "since": "4.4", + "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isencrypted", + "name": "listsystemvms", "required": false, - "since": "4.19.1", + "since": "4.18", "type": "boolean" }, { - "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": "", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "page", + "name": "retrieveonlyresourcecount", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the availability zone", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "list volumes by disk offering", + "description": "the name of the disk volume", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "name", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list only volumes that are encrypted", "length": 255, - "name": "pagesize", + "name": "isencrypted", "required": false, - "type": "integer" + "since": "4.19.1", + "type": "boolean" }, { - "description": "list volumes on specified host", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "projectid", - "related": "", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, - { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", - "length": 255, - "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.", "length": 255, @@ -124867,33 +127394,25 @@ "type": "uuid" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "displayvolume", "required": false, - "since": "4.19.1", - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the type of disk volume", "length": 255, - "name": "account", + "name": "type", "required": false, "type": "string" }, @@ -124906,111 +127425,129 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the disk volume", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "", "length": 255, - "name": "ids", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "page", "required": false, - "since": "4.9", - "type": "list" + "type": "integer" }, { - "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": "displayvolume", + "name": "tags", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" + }, + { + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, + "type": "string" }, { - "description": "the name of the disk volume", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the disk volume", + "description": "", "length": 255, - "name": "id", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of the availability zone", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "ids", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.3", - "type": "string" + "since": "4.9", + "type": "list" }, { - "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": "the type of disk volume", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "type", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "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", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -125019,8 +127556,13 @@ "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { @@ -125028,29 +127570,35 @@ "name": "destroyed", "type": "boolean" }, + {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { @@ -125058,152 +127606,89 @@ "name": "serviceofferingid", "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", + "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": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "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", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -125211,91 +127696,80 @@ "name": "diskiowrite", "type": "long" }, - {}, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ID of the disk offering", + "name": "diskofferingid", "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 disk utilization", + "name": "utilization", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "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": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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 name of the volume", + "name": "podname", "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": "the disk utilization", - "name": "utilization", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the format of the disk encryption if applicable", @@ -125303,104 +127777,162 @@ "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": "name of the virtual machine", - "name": "vmname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "state of the virtual machine", + "name": "vmstate", "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": "the chain info of the volume", - "name": "chaininfo", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "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 primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the project name of the vpn", + "name": "project", "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" } ] }, @@ -125410,16 +127942,23 @@ "name": "createLBHealthCheckPolicy", "params": [ { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, - "name": "responsetimeout", + "name": "unhealthythreshold", "required": false, "type": "integer" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "unhealthythreshold", + "name": "intervaltime", + "required": false, + "type": "integer" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "length": 255, + "name": "healthythreshold", "required": false, "type": "integer" }, @@ -125445,13 +127984,6 @@ "required": true, "type": "uuid" }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "length": 255, - "name": "healthythreshold", - "required": false, - "type": "integer" - }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -125461,37 +127993,59 @@ "type": "boolean" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "intervaltime", + "name": "responsetimeout", "required": false, "type": "integer" } ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "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": "the description of the healthcheck policy", - "name": "description", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { @@ -125500,14 +128054,14 @@ "type": "int" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "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", @@ -125523,42 +128077,20 @@ "type": "list" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "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" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -125568,18 +128100,18 @@ "name": "changeSharedFileSystemServiceOffering", "params": [ { - "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" }, { - "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" } @@ -125587,103 +128119,87 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, - {}, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "name of the shared filesystem", + "name": "name", "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 ID of the shared filesystem", - "name": "networkid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -125692,23 +128208,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -125717,46 +128233,46 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -125765,44 +128281,29 @@ "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { "description": "name of the storage fs data volume", "name": "volumename", "type": "string" }, + {}, { - "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": "the disk utilization", - "name": "utilization", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { @@ -125811,48 +128312,8 @@ "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { @@ -125860,44 +128321,39 @@ "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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 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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "name of the vpc to which the nic belongs", @@ -125905,43 +128361,48 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "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": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -125950,29 +128411,29 @@ "type": "integer" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "the gateway of IPv6 network", @@ -125980,13 +128441,13 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -125995,32 +128456,103 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "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 gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "list" }, + { + "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": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + {}, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "ID of the storage fs vm", "name": "vmstate", "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" } ], "since": "4.20.0" @@ -126052,126 +128584,131 @@ "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user firstname", + "name": "firstname", "type": "string" }, + {}, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, { "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, - {}, - { - "description": "the 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": "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 user state", + "name": "state", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "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 user firstname", - "name": "firstname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the account name of the user", - "name": "account", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the role", + "name": "roletype", "type": "string" }, - {}, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", + "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 user state", - "name": "state", + "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 domain ID of the user", + "name": "domainid", + "type": "string" } ] }, @@ -126182,12 +128719,18 @@ "params": [], "related": "", "response": [ + {}, { "description": "the Cloudian connector enabled state", "name": "enabled", "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", @@ -126197,12 +128740,6 @@ "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" } ], "since": "4.11.0" @@ -126213,19 +128750,29 @@ "name": "createNetwork", "params": [ { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "endipv6", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "ip6cidr", + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, + { + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" + }, { "description": "the AS Number of the network", "length": 255, @@ -126235,48 +128782,72 @@ "type": "long" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "account", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the zone ID for the network", "length": 255, - "name": "startipv6", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "MTU to be configured on the network VR's private interface(s)", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" + }, + { + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", "required": false, "type": "string" }, { - "description": "the ID or VID of the network", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "vlan", + "name": "account", "required": false, "type": "string" }, { - "description": "the VPC network belongs to", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the beginning IP address in the network IP range", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "startip", + "name": "netmask", "required": false, "type": "string" }, { - "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "acltype", + "name": "routeripv6", "required": false, + "since": "4.16", "type": "string" }, + { + "description": "an optional project for the network", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "Network ACL ID associated for the network", "length": 255, @@ -126286,11 +128857,26 @@ "type": "uuid" }, { - "description": "the network offering ID", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, + "name": "tungstenvirtualrouteruuid", + "required": false, + "type": "string" + }, + { + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", + "type": "string" + }, + { + "description": "the physical network ID the network belongs to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, "type": "uuid" }, { @@ -126303,70 +128889,70 @@ "type": "list" }, { - "description": "the display text of the network", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "displaytext", + "name": "ip6gateway", "required": false, "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,", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "sourcenatipaddress", + "name": "startip", "required": false, - "since": "4.19", "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "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": "ip6gateway", + "name": "subdomainaccess", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "hideipaddressusage", + "name": "routerip", "required": false, - "type": "boolean" + "since": "4.16", + "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": "ID of the network in an external system.", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "externalid", + "name": "gateway", "required": false, "type": "string" }, { - "description": "an optional project for the network", + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the second IPv6 DNS for the network", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "ip6dns2", + "name": "cidrsize", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.20.0", + "type": "integer" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "displaynetwork", + "name": "isolatedpvlan", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The network this network is associated to. only available if create a Shared network", @@ -126378,42 +128964,39 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "privatemtu", + "name": "displaynetwork", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "boolean" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "network domain", "length": 255, - "name": "routeripv6", + "name": "networkdomain", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the first IPv6 DNS for the network", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "ip6dns1", + "name": "startipv6", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the isolated private VLAN for this 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": "isolatedpvlan", + "name": "acltype", "required": false, "type": "string" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "the display text of the network", "length": 255, - "name": "subdomainaccess", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the isolated private VLAN type for this network", @@ -126422,13 +129005,6 @@ "required": false, "type": "string" }, - { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, { "description": "the name of the network", "length": 255, @@ -126437,34 +129013,18 @@ "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": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", + "description": "the second IPv6 DNS for the network", "length": 255, - "name": "dns2", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "the first IPv4 DNS for the network", + "description": "ID of the network in an external system.", "length": 255, - "name": "dns1", + "name": "externalid", "required": false, - "since": "4.18.0", "type": "string" }, { @@ -126475,90 +129035,47 @@ "type": "boolean" }, { - "description": "IPV4 address to be assigned to a router in a shared network", - "length": 255, - "name": "routerip", - "required": false, - "since": "4.16", - "type": "string" - }, - { - "description": "the physical network ID the network belongs to", + "description": "the network offering ID", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, "type": "uuid" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks 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": "Tungsten-Fabric virtual router the network belongs to", - "length": 255, - "name": "tungstenvirtualrouteruuid", - "required": false, - "type": "string" - }, - { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the ID or VID of the network", "length": 255, - "name": "gateway", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the zone ID for the network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "publicmtu", + "name": "dns2", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "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 id of the network", - "name": "id", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -126567,135 +129084,54 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service 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 physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the 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": "the traffic type of the network", - "name": "traffictype", + "description": "the network's netmask", + "name": "netmask", "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": "related to what other network configuration", - "name": "related", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", "name": "reservediprange", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -126703,94 +129139,141 @@ "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "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 public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the name of the network", - "name": "name", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "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": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "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": "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": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" }, { "description": "the type of the network", @@ -126798,130 +129281,123 @@ "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, - {}, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "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": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, - {}, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { @@ -126930,14 +129406,14 @@ "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { "description": "path of the Domain the network belongs to", @@ -126945,117 +129421,183 @@ "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The external id of the network", + "name": "externalid", "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + {}, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, + {}, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of services", + "name": "service", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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 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 service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" }, { - "description": "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": "customer associated with the tag", - "name": "customer", + "description": "the service name", + "name": "name", "type": "string" } ], "type": "list" }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, { "description": "if network offering supports vm autoscaling feature", "name": "supportsvmautoscaling", @@ -127069,23 +129611,33 @@ "name": "listNetworkOfferings", "params": [ { - "description": "list network offerings by guest type: shared or isolated", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "guestiptype", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "the tags for the network offering.", + "description": "list network offerings by ID", "length": 255, - "name": "specifyvlan", + "name": "id", + "related": "listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if offering has tags specified", + "description": "", "length": 255, - "name": "istagged", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "true if need to list only default network offerings. Default value is false", + "length": 255, + "name": "isdefault", "required": false, "type": "boolean" }, @@ -127097,62 +129649,60 @@ "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "list network offerings by guest type: shared or isolated", "length": 255, - "name": "specifyipranges", + "name": "guestiptype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by ID", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list network offerings by state", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "state", + "name": "availability", "required": false, "type": "string" }, { - "description": "list network offerings supporting certain services", + "description": "list network offerings by display text", "length": 255, - "name": "supportedservices", + "name": "displaytext", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", + "description": "list by traffic type", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "traffictype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "list network offerings by state", "length": 255, - "name": "isdefault", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "true if offering has tags specified", "length": 255, - "name": "keyword", + "name": "istagged", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list network offerings available for network creation in specific zone", @@ -127163,60 +129713,52 @@ "type": "uuid" }, { - "description": "list by traffic type", + "description": "list network offerings by name", "length": 255, - "name": "traffictype", + "name": "name", "required": false, "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" - }, - { - "description": "list network offerings available for network creation in specific domain", + "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": "domainid", - "related": "listDomains", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "list network offerings by display text", + "description": "list network offerings supporting certain services", "length": 255, - "name": "displaytext", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "page", + "name": "sourcenatsupported", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network offerings by name", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "name", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the availability of network offering. Default value is required", + "description": "List by keyword", "length": 255, - "name": "availability", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "the tags for the network offering.", "length": 255, - "name": "sourcenatsupported", + "name": "specifyvlan", "required": false, "type": "boolean" }, @@ -127232,59 +129774,63 @@ "related": "", "response": [ { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "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": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "description": "availability of the network offering", + "name": "availability", + "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" }, { - "description": "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": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { @@ -127293,38 +129839,54 @@ "type": "boolean" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + {}, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, { "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "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": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { @@ -127332,29 +129894,55 @@ "name": "serviceofferingid", "type": "string" }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "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 default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "state of the network provider", "name": "state", @@ -127370,28 +129958,33 @@ "name": "id", "type": "string" }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" } ], "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", @@ -127401,6 +129994,11 @@ "description": "the capability value", "name": "value", "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" } ], "type": "list" @@ -127409,86 +130007,30 @@ "type": "list" }, { - "description": "the id of the network offering", - "name": "id", - "type": "string" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" - }, - { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "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": "availability of the network offering", - "name": "availability", + "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": "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": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the id of the network offering", + "name": "id", "type": "string" - }, - {} + } ] }, { @@ -127497,11 +130039,19 @@ "name": "listDedicatedPods", "params": [ { - "description": "", + "description": "the ID of the domain associated with the pod", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "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" }, { "description": "list dedicated pods by affinity group", @@ -127512,11 +130062,11 @@ "type": "uuid" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the pod", @@ -127526,14 +130076,6 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of the domain associated with the pod", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -127544,28 +130086,33 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "", "response": [ + {}, {}, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { @@ -127574,24 +130121,19 @@ "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -127601,40 +130143,33 @@ "name": "listVPCs", "params": [ { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPC supporting certain services", + "description": "list VPCs by state", "length": 255, - "name": "supportedservices", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "list by zone", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by display text of the VPC", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "displaytext", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list VPC by id", @@ -127652,54 +130187,49 @@ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "flag to display the resource icon for VPCs", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "showicon", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by display text of the VPC", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list VPCs by restartRequired option", + "description": "list by zone", "length": 255, - "name": "restartrequired", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPCs by state", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "state", + "name": "cidr", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "list by ID of the VPC offering", @@ -127710,34 +130240,32 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "tags", + "name": "showicon", "required": false, - "type": "map" + "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": "", + "name": "tags", "required": false, - "type": "uuid" + "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": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list VPC supporting certain services", "length": 255, - "name": "fordisplay", + "name": "supportedservices", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { "description": "list by name of the VPC", @@ -127745,78 +130273,81 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createVPC,listVPCs,updateVPC", "response": [ - {}, { "description": "the name of the zone the VPC belongs to", "name": "zonename", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "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 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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -127825,8 +130356,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -127835,82 +130366,36 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the owner of the VPC", - "name": "account", - "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": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - {}, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project name of the VPC", - "name": "project", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { @@ -127919,33 +130404,28 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { @@ -127954,26 +130434,58 @@ "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -127987,71 +130499,55 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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 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 physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the provider name", + "name": "name", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the id of the VPC", - "name": "id", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { @@ -128060,13 +130556,8 @@ "type": "date" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { @@ -128075,78 +130566,62 @@ "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" - } - ] - }, - { - "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", - "isasync": true, - "name": "runDiagnostics", - "params": [ + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", - "length": 255, - "name": "type", - "required": true, + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "The ID of the system VM instance to diagnose", - "length": 255, - "name": "targetid", - "related": "startSystemVm", - "required": true, - "type": "uuid" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "Additional command line options that apply for each command", - "length": 255, - "name": "params", - "required": false, + "description": "the project name of the VPC", + "name": "project", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the standard error output from the command execution", - "name": "stderr", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the command execution return code", - "name": "exitcode", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the standard output from the command execution", - "name": "stdout", - "type": "string" + "description": "is vpc 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": "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" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.12.0.0" + }, + {} + ] }, { "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", @@ -128170,6 +130645,11 @@ ], "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", @@ -128180,14 +130660,76 @@ "name": "jobid", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "isasync": true, + "name": "runDiagnostics", + "params": [ + { + "description": "The IP/Domain address to test connection to", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" + }, + { + "description": "The ID of the system VM instance to diagnose", + "length": 255, + "name": "targetid", + "related": "startSystemVm", + "required": true, + "type": "uuid" + }, + { + "description": "Additional command line options that apply for each command", + "length": 255, + "name": "params", + "required": false, + "type": "string" + }, + { + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "length": 255, + "name": "type", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {} - ] + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the standard output from the command execution", + "name": "stdout", + "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" + } + ], + "since": "4.12.0.0" }, { "description": "Restarts a VPC", @@ -128201,6 +130743,14 @@ "required": false, "type": "boolean" }, + { + "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 VPC", "length": 255, @@ -128215,38 +130765,30 @@ "name": "cleanup", "required": false, "type": "boolean" - }, - { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", - "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -128256,12 +130798,11 @@ "name": "quotaConfigureEmail", "params": [ { - "description": "Account ID for which to configure quota template email or min balance", + "description": "If the quota email template should be enabled", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", - "required": true, - "type": "uuid" + "name": "enable", + "required": false, + "type": "boolean" }, { "description": "Quota email template name which should be configured", @@ -128271,36 +130812,41 @@ "type": "string" }, { - "description": "New quota account min balance", + "description": "Account ID for which to configure quota template email or min balance", "length": 255, - "name": "minbalance", - "required": false, - "type": "double" + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": true, + "type": "uuid" }, { - "description": "If the quota email template should be enabled", + "description": "New quota account min balance", "length": 255, - "name": "enable", + "name": "minbalance", "required": false, - "type": "boolean" + "type": "double" } ], "related": "", "response": [ { - "description": "The configured account's min balance.", - "name": "minbalance", - "type": "double" + "description": "The template's name.", + "name": "templatename", + "type": "string" }, - {}, { "description": "Whether the template is enabled.", "name": "enabled", "type": "boolean" }, { - "description": "The template's name.", - "name": "templatename", + "description": "The configured account's min balance.", + "name": "minbalance", + "type": "double" + }, + { + "description": "The configured account's id.", + "name": "account", "type": "string" }, { @@ -128308,17 +130854,13 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "The configured account's id.", - "name": "account", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.20.0.0" }, @@ -128330,7 +130872,7 @@ { "description": "Credentials to reach external dhcp device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -128342,9 +130884,9 @@ "type": "string" }, { - "description": "Type of dhcp device", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "dhcpservertype", + "name": "username", "required": true, "type": "string" }, @@ -128357,40 +130899,29 @@ "type": "uuid" }, { - "description": "Credentials to reach external dhcp device", + "description": "Type of dhcp device", "length": 255, - "name": "password", + "name": "dhcpservertype", "required": true, "type": "string" } ], "related": "listBaremetalDhcp", "response": [ + {}, { - "description": "device id of ", - "name": "id", - "type": "string" - }, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "name of the provider", "name": "provider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { @@ -128398,11 +130929,22 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "device id of ", + "name": "id", + "type": "string" + }, { "description": "url", "name": "url", "type": "string" - } + }, + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {} ] }, { @@ -128432,18 +130974,18 @@ "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", @@ -128456,14 +130998,6 @@ "isasync": true, "name": "copySnapshot", "params": [ - { - "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 snapshot.", "length": 255, @@ -128472,6 +131006,14 @@ "required": true, "type": "uuid" }, + { + "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", + "length": 255, + "name": "sourcezoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "The ID of the zone the snapshot is being copied to.", "length": 255, @@ -128481,118 +131023,69 @@ "type": "uuid" }, { - "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", + "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": "sourcezoneid", + "name": "destzoneids", "related": "listZones", "required": false, - "type": "uuid" + "type": "list" } ], "related": "listSnapshots", "response": [ { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "name of the availability zone", + "name": "zonename", + "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, - {}, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "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": "type of the disk volume", - "name": "volumetype", + "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 disk volume", + "name": "volumename", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { @@ -128601,30 +131094,25 @@ "type": "boolean" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { "description": "path of the Domain the snapshot's account belongs to", "name": "domainpath", "type": "string" }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, { "description": "ID of the disk volume", "name": "volumeid", @@ -128635,39 +131123,31 @@ "name": "datastorestate", "type": "string" }, + {}, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -128676,49 +131156,111 @@ "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name of the snapshot", - "name": "project", + "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 domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", - "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 snapshot's account", - "name": "domainid", + "description": "the status of the template", + "name": "status", "type": "string" }, { "description": "state of the disk volume", "name": "volumestate", "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" } ], "since": "4.19.0" @@ -128729,10 +131271,10 @@ "name": "addTrafficMonitor", "params": [ { - "description": "URL of the traffic monitor Host", + "description": "Traffic going into the listed zones will be metered", "length": 255, - "name": "url", - "required": true, + "name": "includezones", + "required": false, "type": "string" }, { @@ -128751,36 +131293,37 @@ "type": "string" }, { - "description": "Traffic going into the listed zones will be metered", + "description": "URL of the traffic monitor Host", "length": 255, - "name": "includezones", - "required": false, + "name": "url", + "required": true, "type": "string" } ], "related": "", "response": [ + {}, + {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the zone ID of the external firewall", + "name": "zoneid", "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 management IP address of the external firewall", - "name": "ipaddress", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -128795,8 +131338,7 @@ "description": "the ID of the external firewall", "name": "id", "type": "string" - }, - {} + } ] }, { @@ -128805,31 +131347,30 @@ "name": "listUsers", "params": [ { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "", "length": 255, - "name": "accounttype", + "name": "page", "required": false, "type": "integer" }, { - "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": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, @@ -128848,12 +131389,11 @@ "type": "boolean" }, { - "description": "List user by ID.", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "id", - "related": "disableUser,getUser,listUsers", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List users by state of the user account.", @@ -128869,6 +131409,14 @@ "required": false, "type": "integer" }, + { + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers", + "required": false, + "type": "uuid" + }, { "description": "List user by the username", "length": 255, @@ -128877,96 +131425,88 @@ "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 users by the Api key access value", "length": 255, - "name": "listall", + "name": "apikeyaccess", "required": false, - "type": "boolean" + "since": "4.20.1.0", + "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": "listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "disableUser,getUser", "response": [ - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, { "description": "the user firstname", "name": "firstname", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, + {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "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 ID", + "name": "id", "type": "string" }, - {}, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -128975,20 +131515,29 @@ "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", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, - {}, { - "description": "the 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 domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" }, { "description": "the name of the role", @@ -128996,9 +131545,9 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the user lastname", @@ -129006,23 +131555,29 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { - "description": "the user name", - "name": "username", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -129033,37 +131588,23 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "the gateway of the IPv6 network", - "length": 255, - "name": "ip6gateway", - "required": false, - "type": "string" - }, - { - "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 ending IPv6 address in the IPv6 network range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "endipv6", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "ip6cidr", + "name": "ip6gateway", "required": false, "type": "string" }, @@ -129097,9 +131638,23 @@ "type": "uuid" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "startipv6", + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, + "type": "string" + }, + { + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", "required": false, "type": "string" } @@ -129107,64 +131662,69 @@ "related": "", "response": [ { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "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 Pod ID for the VLAN IP range", - "name": "podid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, + {}, { "description": "indicates whether IP range is dedicated to NSX resources or not", "name": "fornsx", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the 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 project id of the vlan range", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -129172,41 +131732,40 @@ "name": "ip6gateway", "type": "string" }, - {}, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "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": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, { "description": "path of the domain to which the VLAN IP range belongs", @@ -129218,36 +131777,32 @@ "name": "description", "type": "string" }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, { "description": "the start ip of the VLAN IP range", "name": "startip", "type": "string" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the domain ID of the VLAN IP range", "name": "domainid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the 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" + }, + {} ], "since": "4.16.0" }, @@ -129257,26 +131812,25 @@ "name": "listResourceLimits", "params": [ { - "description": "List by keyword", + "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "keyword", + "name": "resourcetype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "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": "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": "Lists resource limits by ID.", "length": 255, - "name": "resourcetype", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -129286,18 +131840,19 @@ "type": "string" }, { - "description": "Lists resource limits by ID.", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "resourcetypename", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Tag for the resource type", @@ -129308,12 +131863,11 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "listDomains", + "name": "resourcetypename", "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.", @@ -129323,91 +131877,92 @@ "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "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 domain name of the resource limit", + "name": "domain", "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": "the project name of the resource limit", - "name": "project", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the domain 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 account of the resource limit", - "name": "account", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "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 name of the resource limit", - "name": "domain", + "description": "the project id of the resource limit", + "name": "projectid", "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": "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 tag for the resource limit", + "name": "tag", "type": "string" - } + }, + {}, + {} ] }, { @@ -129427,70 +131982,80 @@ "related": "getUser", "response": [ { - "description": "the user ID", - "name": "id", + "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, {}, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the account name of the user", - "name": "account", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + {}, + { + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -129499,64 +132064,59 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the 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", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" } ] }, @@ -129566,33 +132126,27 @@ "name": "listIsos", "params": [ { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ispublic", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "ID of the storage pool", + "description": "ID of the image or image cache store", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "imagestoreid", + "related": "listSwifts", "required": false, "since": "4.19", "type": "uuid" }, { - "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.", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "isrecursive", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { @@ -129604,137 +132158,143 @@ "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "ID of the storage pool", "length": 255, - "name": "hypervisor", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "list all ISOs by name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "tags", + "name": "showicon", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "If set to true, list only unique isos 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": "ID of the image or image cache store", + "description": "the ID of the zone", "length": 255, - "name": "imagestoreid", - "related": "listSwifts", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "flag to display the resource image for the isos", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "showicon", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "keyword", + "name": "hypervisor", "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" }, { - "description": "list ISO by ID", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "listall", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "show removed ISOs as well", + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "showremoved", + "name": "isofilter", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "bootable", + "name": "listall", "required": false, "type": "boolean" }, { - "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": "true if this ISO is ready to be deployed", + "description": "list ISO by ID", "length": 255, - "name": "isready", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list all ISOs by name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "description": "show removed ISOs as well", "length": 255, - "name": "arch", + "name": "showremoved", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "the ID of the zone", + "description": "true if the ISO is bootable, false otherwise", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "bootable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "true if this ISO is ready to be deployed", "length": 255, - "name": "isofilter", + "name": "isready", "required": false, - "type": "string" + "type": "boolean" } ], "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", @@ -129745,78 +132305,89 @@ "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, + {}, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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" }, { @@ -129825,52 +132396,103 @@ "type": "integer" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if 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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + {}, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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 template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -129879,8 +132501,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -129894,108 +132516,66 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - {}, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the template ID", + "name": "id", "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": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, - {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -130004,8 +132584,13 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -130014,38 +132599,23 @@ "type": "set" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { @@ -130054,29 +132624,19 @@ "type": "imageformat" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template name", + "name": "name", "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": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" } ] }, @@ -130094,55 +132654,62 @@ "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 the autoscale vm group", + "description": "", "length": 255, - "name": "vmgroupid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "the name of the autoscale policy", "length": 255, - "name": "action", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "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": "boolean" + }, + { + "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.", + "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": "the ID of the autoscale policy", "length": 255, - "name": "listall", + "name": "id", + "related": "listAutoScalePolicies", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the autoscale policy", + "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, - "since": "4.18.0", - "type": "string" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -130153,34 +132720,27 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "the ID of the condition of the policy", "length": 255, - "name": "page", + "name": "conditionid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the autoscale policy", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "vmgroupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the condition of the policy", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "conditionid", - "related": "", + "name": "action", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", @@ -130191,13 +132751,13 @@ "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": "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" }, { @@ -130206,13 +132766,8 @@ "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", - "type": "string" - }, - { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, {}, @@ -130222,9 +132777,9 @@ "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 list of IDs of the conditions that are being evaluated on every interval", @@ -130232,29 +132787,34 @@ "type": "list" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "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 account owning the autoscale policy", - "name": "account", + "description": "the autoscale policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" } ] @@ -130264,21 +132824,6 @@ "isasync": true, "name": "dedicateIpv4SubnetForZone", "params": [ - { - "description": "project who will own the IPv4 subnet", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "account who will own the IPv4 subnet", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "domain ID of the account owning the IPv4 subnet", "length": 255, @@ -130294,44 +132839,64 @@ "related": "dedicateIpv4SubnetForZone", "required": true, "type": "uuid" + }, + { + "description": "project who will own the IPv4 subnet", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { "description": "id of zone to which the IPv4 subnet belongs to.", "name": "zoneid", "type": "string" }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, { "description": "the project name of the IPv4 subnet", "name": "project", "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "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": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { @@ -130339,25 +132904,20 @@ "name": "jobid", "type": "string" }, - { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" - }, + {}, { "description": "guest IPv4 subnet", "name": "subnet", "type": "string" }, - {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" } ], @@ -130369,12 +132929,11 @@ "name": "listSharedFileSystems", "params": [ { - "description": "the ID of the network", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "list only resources belonging to the domain specified", @@ -130384,13 +132943,6 @@ "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, @@ -130406,34 +132958,26 @@ "type": "integer" }, { - "description": "List resources 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.", + "description": "the ID of the network", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list 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": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the disk offering of the shared filesystem", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the ID of the availability zone", @@ -130444,18 +132988,19 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "the disk offering of the shared filesystem", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "diskofferingid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -130465,49 +133010,84 @@ "type": "integer" }, { - "description": "the ID of the shared filesystem", + "description": "the service offering of the shared filesystem", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "the service offering of the shared filesystem", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, { "description": "the name of the shared filesystem", "length": 255, "name": "name", "required": false, "type": "string" + }, + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "required": false, + "type": "uuid" } ], "related": "changeSharedFileSystemDiskOffering", "response": [ { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { @@ -130521,42 +133101,42 @@ "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "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": "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": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -130565,84 +133145,89 @@ "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "public IP address 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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the isolated private VLAN if available", @@ -130650,161 +133235,75 @@ "type": "integer" }, { - "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": "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, { "description": "the isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" } ], "type": "list" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "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 shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -130813,28 +133312,28 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -130843,8 +133342,8 @@ "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" }, { @@ -130853,16 +133352,37 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "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": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { @@ -130871,59 +133391,99 @@ "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "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": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" } ], @@ -130945,15 +133505,16 @@ "related": "", "response": [ { - "description": "id of rct", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "url", @@ -130961,11 +133522,10 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "id of rct", + "name": "id", + "type": "string" + } ] }, { @@ -130974,23 +133534,30 @@ "name": "updateRole", "params": [ { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "The description of the role", "length": 255, - "name": "type", + "name": "description", "required": false, "type": "string" }, { - "description": "creates a role with this unique name", + "description": "The description of the role", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "The description of the role", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "description", + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "creates a role with this unique name", + "length": 255, + "name": "name", "required": false, "type": "string" }, @@ -131008,32 +133575,33 @@ "related": "listRoles,updateRole", "required": true, "type": "uuid" - }, - { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "listRoles", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the role", + "name": "state", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the type of the role", "name": "type", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -131041,31 +133609,23 @@ "name": "name", "type": "string" }, + {}, { - "description": "the state of the role", - "name": "state", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the 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": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } + {} ], "since": "4.9.0" }, @@ -131075,18 +133635,11 @@ "name": "listRemoteAccessVpns", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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": "Lists remote access vpn rule with the specified ID", @@ -131097,23 +133650,6 @@ "since": "4.3", "type": "uuid" }, - { - "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", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "since": "4.3", - "type": "uuid" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -131131,30 +133667,33 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 remote access VPNs for certain network", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "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" }, @@ -131165,86 +133704,107 @@ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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 range of ips to allocate to the clients", - "name": "iprange", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "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 domain name of the account of the remote access vpn", - "name": "domain", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the range of ips to allocate to the clients", + "name": "iprange", + "type": "string" }, - {}, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, + {}, { - "description": "the state of the rule", - "name": "state", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, - {}, { - "description": "the 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" } ] }, @@ -131263,27 +133823,27 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, {} ], "since": "4.20.0" @@ -131304,27 +133864,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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" + } ] }, { @@ -131342,27 +133902,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", + "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" } ] }, @@ -131372,26 +133932,20 @@ "name": "createServiceInstance", "params": [ { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "The name of the service instance", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "name", + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, - "type": "string" - }, - { - "description": "An optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "type": "uuid" }, { "description": "Availability zone for the service instance", @@ -131402,11 +133956,18 @@ "type": "uuid" }, { - "description": "The template ID that specifies the image for the service appliance", + "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Project ID for the service instance", + "length": 255, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { @@ -131418,51 +133979,50 @@ "type": "uuid" }, { - "description": "Project ID for the service instance", + "description": "The template ID that specifies the image for the service appliance", "length": 255, - "name": "projectid", - "related": "", - "required": false, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { - "description": "The right (outside) network ID for the service instance", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "The name of the service instance", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -131471,35 +134031,35 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "path of the Domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - {}, { - "description": "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" } ] }, @@ -131520,79 +134080,68 @@ "related": "", "response": [ { - "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", - "type": "string" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the Pod ID for the system VM", + "name": "podid", "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 system VM type", - "name": "systemvmtype", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "guest vlan range", + "name": "guestvlan", "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": "public vlan range", "name": "publicvlan", "type": "list" }, { - "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": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -131601,10 +134150,20 @@ "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the link local MAC address for the system vm", "name": "linklocalmacaddress", @@ -131612,123 +134171,129 @@ }, {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, + {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "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 template name for the system VM", - "name": "templatename", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the 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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the state of the system VM", + "name": "state", "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 state of the system VM", - "name": "state", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "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 template ID for the system VM", - "name": "templateid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" } ] @@ -131738,13 +134303,6 @@ "isasync": false, "name": "registerVnfTemplate", "params": [ - { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" - }, { "description": "true if this template is a featured template, false otherwise", "length": 255, @@ -131753,11 +134311,12 @@ "type": "boolean" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "length": 255, + "name": "zoneids", + "related": "listZones", + "required": false, + "type": "list" }, { "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", @@ -131767,6 +134326,13 @@ "since": "4.19.0", "type": "string" }, + { + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, { "description": "true if the template is available to all accounts; default is true", "length": 255, @@ -131775,12 +134341,18 @@ "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": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "ostypeid", - "related": "", + "name": "details", "required": false, - "type": "uuid" + "type": "map" + }, + { + "description": "the name of the template", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", @@ -131790,26 +134362,35 @@ "type": "map" }, { - "description": "true if this template requires HVM", + "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": "requireshvm", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "isdynamicallyscalable", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "templatetag", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, + { + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" + }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, @@ -131819,27 +134400,56 @@ "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "account", + "name": "deployasis", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "zoneids", + "name": "zoneid", "related": "listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "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": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "checksum", + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, + { + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "length": 255, + "name": "vnfnics", + "required": false, + "type": "map" + }, { "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, @@ -131848,11 +134458,10 @@ "type": "boolean" }, { - "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" }, { @@ -131863,12 +134472,11 @@ "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "true if the template or its derivatives are extractable; default is false", @@ -131878,150 +134486,207 @@ "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "isrouting", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "Register template for the project", "length": 255, - "name": "deployasis", + "name": "projectid", + "related": "", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "uuid" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "details", + "name": "isdynamicallyscalable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "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" + } + ], + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", - "length": 255, - "name": "vnfnics", - "required": false, - "type": "map" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "Register template for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - } - ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "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", + "type": "boolean" + }, {}, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, { "description": "the status of the template", "name": "status", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "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", + "type": "string" + }, + { + "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": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, + { + "description": "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": "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 format of the template.", "name": "format", "type": "imageformat" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "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", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "additional key/value details tied with template", @@ -132029,33 +134694,28 @@ "type": "map" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "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": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "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", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -132063,23 +134723,13 @@ "name": "removed", "type": "date" }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -132087,11 +134737,6 @@ "name": "project", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "path of the Domain associated with the tag", "name": "domainpath", @@ -132103,192 +134748,112 @@ "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": "tag value", + "name": "value", "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 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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "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", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - {}, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "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 physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, { "description": "true if template requires HVM enabled, false otherwise", "name": "requireshvm", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" } ], @@ -132299,21 +134864,6 @@ "isasync": false, "name": "listVirtualMachinesUsageHistory", "params": [ - { - "description": "the IDs of the virtual machines, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": false, - "type": "list" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the virtual machine.", "length": 255, @@ -132323,11 +134873,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "keyword", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", @@ -132336,6 +134886,14 @@ "required": false, "type": "date" }, + { + "description": "the IDs of the virtual machines, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "list" + }, { "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, @@ -132344,54 +134902,61 @@ "type": "string" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "pagesize", "required": false, - "type": "date" + "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": "listSystemVmsUsageHistory", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "type": "string" }, - {}, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, - { - "description": "the 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 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", "type": "list" - }, - {} + } ], "since": "4.17" }, @@ -132412,24 +134977,34 @@ "related": "reconnectHost", "response": [ { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" }, { "description": "the amount of the host's CPU currently used", @@ -132437,38 +135012,43 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "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", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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" }, { @@ -132476,331 +135056,316 @@ "name": "zonename", "type": "string" }, + {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "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": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, - {}, { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the Pod ID of the host", + "name": "podid", "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 date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, { "description": "GPU cards present in the host", "name": "gpugroup", "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 vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, { "description": "Video RAM for this vGPU type", "name": "videoram", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "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 tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "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": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" } ], "since": "4.16.0.0" @@ -132811,86 +135376,94 @@ "name": "createKubernetesCluster", "params": [ { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "Deploy cluster for the project", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "account", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "password for the docker image private registry", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "dockerregistrypassword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "controlnodes", + "name": "masternodes", "required": false, "type": "long" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "clustertype", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "root disk size in GB for each node", + "description": "user name for the docker image private registry", "length": 255, - "name": "noderootdisksize", + "name": "dockerregistryusername", "required": false, - "type": "long" + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the service offering for the virtual machines in the cluster.", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "masternodes", + "name": "externalloadbalanceripaddress", "required": false, - "type": "long" + "type": "string" }, { - "description": "name for the Kubernetes cluster", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" }, { - "description": "Deploy cluster for the project", + "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", "length": 255, - "name": "projectid", - "related": "", + "name": "clustertype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "root disk size in GB for each node", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "noderootdisksize", "required": false, - "type": "uuid" + "type": "long" }, { "description": "Network in which Kubernetes cluster is to be launched", @@ -132901,52 +135474,44 @@ "type": "uuid" }, { - "description": "number of Kubernetes cluster worker nodes", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "description": "Kubernetes version with which cluster to be launched", + "description": "URL for the docker image private registry", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "dockerregistryurl", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "password for the docker image private registry", "length": 255, - "name": "description", + "name": "dockerregistrypassword", "required": false, "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "keypair", + "name": "account", "required": false, "type": "string" }, { - "description": "user name for the docker image private registry", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "dockerregistryusername", + "name": "controlnodes", "required": false, - "type": "string" + "type": "long" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "externalloadbalanceripaddress", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "URL for the docker image private registry", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "dockerregistryurl", + "name": "keypair", "required": false, "type": "string" } @@ -132954,69 +135519,84 @@ "related": "startKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, + {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, - {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "name": "zonename", "type": "string" }, + { + "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 memory the Kubernetes cluster", - "name": "memory", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -133025,69 +135605,74 @@ "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the date when this Kubernetes cluster 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 memory the Kubernetes cluster", + "name": "memory", + "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 template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "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": "keypair details", "name": "keypair", "type": "string" }, + {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { @@ -133096,8 +135681,8 @@ "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { @@ -133106,14 +135691,14 @@ "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { "description": "the account associated with the Kubernetes cluster", @@ -133121,29 +135706,9 @@ "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, - { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" } ] }, @@ -133153,19 +135718,19 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "List by keyword", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", @@ -133176,65 +135741,60 @@ "type": "uuid" }, { - "description": "", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "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": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "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 start ip of the storage network IP range", + "name": "startip", "type": "string" }, { @@ -133243,8 +135803,13 @@ "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { @@ -133253,8 +135818,8 @@ "type": "integer" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" } ], @@ -133265,6 +135830,13 @@ "isasync": true, "name": "configureVirtualRouterElement", "params": [ + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" + }, { "description": "the ID of the virtual router provider", "length": 255, @@ -133272,20 +135844,34 @@ "related": "configureVirtualRouterElement", "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the account associated with the provider", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, { "description": "Enabled/Disabled the service provider", - "length": 255, "name": "enabled", - "required": true, "type": "boolean" - } - ], - "related": "", - "response": [ + }, + {}, { - "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" }, { @@ -133293,20 +135879,15 @@ "name": "domainpath", "type": "string" }, - {}, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, + {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -133319,27 +135900,11 @@ "name": "id", "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" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - {} + } ] }, { @@ -133359,32 +135924,26 @@ "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 HA state of the host", - "name": "hastate", - "type": "hastate" - }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, + {}, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, { "description": "the host HA provider", "name": "haprovider", @@ -133394,6 +135953,12 @@ "description": "operation status", "name": "status", "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -133412,17 +135977,17 @@ "type": "uuid" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "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": "affinitygroupids", + "name": "affinitygroupnames", "related": "", "required": false, "type": "list" }, { - "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", + "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": "affinitygroupnames", + "name": "affinitygroupids", "related": "", "required": false, "type": "list" @@ -133431,34 +135996,29 @@ "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "NICs of the VNF appliance", @@ -133466,231 +136026,68 @@ "type": "list" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "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 list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "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 type if available", - "name": "isolatedpvlantype", - "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": "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, - {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -133699,102 +136096,20 @@ "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the project name of the vm", - "name": "project", + "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": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, { "description": "the name of the host for the virtual machine", "name": "hostname", @@ -133805,104 +136120,19 @@ "name": "name", "type": "string" }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, { "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the 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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, { "description": "OS type id of the vm", "name": "ostypeid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -133910,32 +136140,119 @@ "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "account owning the security group rule", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -133943,18 +136260,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -133968,8 +136280,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -133988,44 +136310,49 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "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 CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -134034,17 +136361,32 @@ "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -134052,33 +136394,48 @@ "name": "startport", "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": "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", + "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -134087,13 +136444,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -134102,8 +136459,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -134113,36 +136470,6 @@ } ], "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" @@ -134153,206 +136480,285 @@ "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the description of the security group", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], "type": "set" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "User VM type", - "name": "vmtype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", @@ -134363,8 +136769,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -134373,18 +136779,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -134398,57 +136799,169 @@ "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", + "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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "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": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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" }, { @@ -134457,13 +136970,33 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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" }, { @@ -134472,13 +137005,13 @@ "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -134487,39 +137020,76 @@ "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 userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 group name of the virtual machine", + "name": "group", + "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": "the VM's primary IP address", - "name": "ipaddress", + "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 target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" } ] }, @@ -134529,49 +137099,49 @@ "name": "registerNetscalerServicePackage", "params": [ { - "description": "Name of the service Package.", + "description": "Description of Service Package", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" }, { - "description": "Description of Service Package", + "description": "Name of the service Package.", "length": 255, - "name": "description", + "name": "name", "required": true, "type": "string" } ], "related": "listRegisteredServicePackages", "response": [ + { + "description": "Service Package Name", + "name": "name", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Service Package Name", - "name": "name", + "description": "Service Package UUID", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Service Package UUID", - "name": "id", - "type": "string" - }, { "description": "Description of Service Package", "name": "description", "type": "string" - }, - {}, - {} + } ] }, { @@ -134580,75 +137150,64 @@ "name": "updateWebhook", "params": [ { - "description": "Payload URL of the Webhook", + "description": "Name for the Webhook", "length": 255, - "name": "payloadurl", + "name": "name", "required": false, "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "Secret key of the Webhook", "length": 255, - "name": "sslverification", + "name": "secretkey", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The ID of the Webhook", + "description": "Payload URL of the Webhook", "length": 255, - "name": "id", - "related": "createWebhook", - "required": true, - "type": "uuid" + "name": "payloadurl", + "required": false, + "type": "string" }, { - "description": "State of the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "state", + "name": "scope", "required": false, "type": "string" }, { - "description": "Description for the Webhook", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "description", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Name for the Webhook", + "description": "State of the Webhook", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "Secret key of the Webhook", + "description": "The ID of the Webhook", "length": 255, - "name": "secretkey", - "required": false, - "type": "string" + "name": "id", + "related": "createWebhook", + "required": true, + "type": "uuid" }, { - "description": "Scope of the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "scope", + "name": "description", "required": false, "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", @@ -134659,6 +137218,17 @@ "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" @@ -134668,6 +137238,13 @@ "isasync": false, "name": "quotaCredits", "params": [ + { + "description": "Value of the credits to be added+, subtracted-", + "length": 255, + "name": "value", + "required": true, + "type": "double" + }, { "description": "Domain for which quota credits need to be added", "length": 255, @@ -134690,13 +137267,6 @@ "required": true, "type": "string" }, - { - "description": "Value of the credits to be added+, subtracted-", - "length": 255, - "name": "value", - "required": true, - "type": "double" - }, { "description": "Minimum balance threshold of the account", "length": 255, @@ -134707,11 +137277,7 @@ ], "related": "", "response": [ - { - "description": "the credit deposited", - "name": "credits", - "type": "bigdecimal" - }, + {}, { "description": "currency", "name": "currency", @@ -134722,6 +137288,11 @@ "name": "updated_on", "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", @@ -134729,11 +137300,10 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the credit deposited", + "name": "credits", + "type": "bigdecimal" }, - {}, { "description": "the user name of the admin who updated the credits", "name": "updated_by", @@ -134764,13 +137334,13 @@ }, {}, { - "description": "The client certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "The client certificate", + "name": "certificate", "type": "string" }, {}, @@ -134780,8 +137350,8 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" } ], @@ -134812,39 +137382,65 @@ "related": "", "response": [ { - "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" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the host", "name": "hostname", "type": "string" }, - {}, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" + }, + { + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, { "description": "the ID of the host", "name": "hostid", "type": "string" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "SAML Global Log Out API", + "isasync": false, + "name": "samlSlo", + "params": [], + "related": "", + "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "Response description", + "name": "description", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} - ], - "since": "4.17.0" + } + ] }, { "description": "Creates a Project role", @@ -134884,42 +137480,42 @@ ], "related": "", "response": [ - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, - {}, { "description": "the name of the role", "name": "name", "type": "string" }, + { + "description": "the ID of the role", + "name": "id", + "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": "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" } ], "since": "4.15.0" @@ -134938,37 +137534,35 @@ "type": "uuid" }, { - "description": "Port", + "description": "Hostname", "length": 255, - "name": "port", + "name": "hostname", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Hostname", + "description": "Port", "length": 255, - "name": "hostname", + "name": "port", "required": true, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "name of the host running the ldap server", - "name": "hostname", + "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": "linked domain", - "name": "domainid", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { @@ -134976,6 +137570,8 @@ "name": "port", "type": "int" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -134996,13 +137592,6 @@ "required": true, "type": "integer" }, - { - "description": "Tungsten-Fabric address group name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "Tungsten-Fabric ip prefix", "length": 255, @@ -135017,37 +137606,38 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric address group name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ + { + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric address group name", - "name": "name", - "type": "string" - }, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", - "type": "string" - }, { "description": "Tungsten-Fabric address group ip prefix length", "name": "ipprefixlen", @@ -135059,9 +137649,15 @@ "type": "string" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -135070,6 +137666,14 @@ "isasync": false, "name": "listBigSwitchBcfDevices", "params": [ + { + "description": "bigswitch BCF controller device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -135085,10 +137689,10 @@ "type": "string" }, { - "description": "bigswitch BCF controller device ID", + "description": "the Physical Network ID", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, @@ -135098,48 +137702,29 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" - }, { "description": "the controller Ip address", "name": "hostname", "type": "string" }, - {}, { "description": "NAT support", "name": "nat", "type": "boolean" }, {}, - { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", - "type": "string" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { @@ -135148,18 +137733,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the controller password", + "name": "password", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the controller password", - "name": "password", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -135171,56 +137767,56 @@ "name": "listRegisteredServicePackages", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "Service Package UUID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Description of Service Package", - "name": "description", + "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", + "description": "Service Package Name", + "name": "name", "type": "string" }, { - "description": "Service Package Name", - "name": "name", + "description": "Description of Service Package", + "name": "description", "type": "string" - } + }, + {}, + {} ] }, { @@ -135229,9 +137825,17 @@ "name": "changeSharedFileSystemDiskOffering", "params": [ { - "description": "the size of the shared filesystem in GiB", + "description": "the ID of the shared filesystem", "length": 255, - "name": "size", + "name": "id", + "related": "changeSharedFileSystemDiskOffering", + "required": true, + "type": "uuid" + }, + { + "description": "min iops", + "length": 255, + "name": "miniops", "required": false, "type": "long" }, @@ -135243,14 +137847,6 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "related": "changeSharedFileSystemDiskOffering", - "required": true, - "type": "uuid" - }, { "description": "max iops", "length": 255, @@ -135259,211 +137855,63 @@ "type": "long" }, { - "description": "min iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "miniops", + "name": "size", "required": false, "type": "long" } ], "related": "", "response": [ - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - {}, { "description": "name of the shared filesystem", "name": "name", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "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": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "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": "the list of resource tags associated", - "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 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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "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": "path to mount the shared filesystem", - "name": "path", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { @@ -135472,23 +137920,18 @@ "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "the project name of the shared filesystem", + "name": "project", + "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": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { @@ -135496,23 +137939,33 @@ "name": "nic", "response": [ { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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 ID of the nic", - "name": "id", + "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 traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -135520,14 +137973,34 @@ "name": "adaptertype", "type": "string" }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, { "description": "the isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -135536,38 +138009,38 @@ "type": "boolean" }, { - "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": "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -135576,97 +138049,180 @@ "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "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 account associated with the shared filesystem", + "name": "account", "type": "string" }, {}, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + {}, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { @@ -135675,33 +138231,73 @@ "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, { "description": "ID of the shared filesystem", "name": "id", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "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", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" } ], @@ -135729,33 +138325,23 @@ "type": "uuid" }, { - "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", + "description": "VM guest NIC secondary IP address for the port forwarding rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "vmguestip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", "length": 255, - "name": "vmguestip", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -135766,7 +138352,17 @@ "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" + } ] }, { @@ -135785,27 +138381,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" - }, - {} + } ] }, { @@ -135823,18 +138419,13 @@ } ], "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", @@ -135844,6 +138435,11 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.20.0" @@ -135854,55 +138450,54 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "32 or 64 bits support. 64 by default", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "bits", + "name": "isrouting", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "the name of the volume/template/iso", "length": 255, - "name": "format", + "name": "name", "required": true, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "ispublic", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Upload volume/template/iso for the project", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "projectid", - "related": "", + "name": "sshkeyenabled", "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 supports the password reset feature; default is false", + "description": "Template details in key/value pairs.", "length": 255, - "name": "passwordenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "the display text of the template. This is usually used for display purposes.", @@ -135912,26 +138507,25 @@ "type": "string" }, { - "description": "the tag for this template.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "templatetag", + "name": "account", "required": false, "type": "string" }, { - "description": "the name of the volume/template/iso", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the tag for this template.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "templatetag", + "required": false, + "type": "string" }, { "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", @@ -135942,11 +138536,11 @@ "type": "boolean" }, { - "description": "Template details in key/value pairs.", + "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": "details", + "name": "checksum", "required": false, - "type": "map" + "type": "string" }, { "description": "true if this template is a featured template, false otherwise", @@ -135956,18 +138550,19 @@ "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "isextractable", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "true if this template requires HVM", "length": 255, - "name": "account", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the target hypervisor for the template", @@ -135977,12 +138572,20 @@ "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "arch", + "name": "projectid", + "related": "", "required": false, - "since": "4.20", - "type": "string" + "type": "uuid" + }, + { + "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": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -135992,9 +138595,9 @@ "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "requireshvm", + "name": "passwordenabled", "required": false, "type": "boolean" }, @@ -136007,35 +138610,29 @@ "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isrouting", + "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.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" } ], "related": "getUploadParamsForIso", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -136043,23 +138640,22 @@ "name": "postURL", "type": "url" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.6.0" }, @@ -136086,28 +138682,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": "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" + } ] }, { @@ -136115,13 +138711,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, @@ -136142,6 +138731,13 @@ "name": "pagesize", "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": "", @@ -136151,11 +138747,10 @@ "name": "traffictype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "implementor of network traffic type", @@ -136163,10 +138758,11 @@ "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" @@ -136178,32 +138774,20 @@ "params": [], "related": "", "response": [ - { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" - }, - { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, { "description": "the name of the active usage server", "name": "hostname", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" }, { "description": "the version of the currently running DB", @@ -136211,24 +138795,25 @@ "type": "string" }, { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", - "type": "string" + "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 last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" }, { "description": "the version of the currently running DB", "name": "version", "type": "string" }, + {}, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" }, { "description": "the current status of the latest async job acting on this object", @@ -136236,9 +138821,20 @@ "type": "integer" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" + }, + {}, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" } ], "since": "4.17.0" @@ -136258,11 +138854,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", @@ -136270,16 +138861,21 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -136289,12 +138885,11 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "the templateid of the autoscale vm profile", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -136304,40 +138899,34 @@ "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 by keyword", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "keyword", + "name": "otherdeployparams", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the autoscale vm profile", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "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": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -136348,75 +138937,87 @@ "type": "uuid" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "", "length": 255, - "name": "otherdeployparams", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fordisplay", "required": false, "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles", + "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 profiles by service offering id", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": false, "since": "4.4", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list profiles by service offering id", "length": 255, - "name": "fordisplay", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "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": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -136424,25 +139025,23 @@ "type": "integer" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -136450,61 +139049,58 @@ "name": "serviceofferingid", "type": "string" }, + {}, + {}, + {}, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "is profile 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 ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, - {}, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "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 autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the project id vm profile", + "name": "projectid", "type": "string" } ] @@ -136515,11 +139111,11 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "user to security group mapping", "length": 255, - "name": "securitygroupname", + "name": "usersecuritygrouplist", "required": false, - "type": "string" + "type": "map" }, { "description": "error code for this icmp message", @@ -136536,54 +139132,55 @@ "type": "string" }, { - "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": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "cidrlist", + "name": "securitygroupid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "end port for this ingress rule", + "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": "endport", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "an optional project of the security group", "length": 255, - "name": "icmptype", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "start port for this ingress rule", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "an optional project of the security group", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "projectid", - "related": "", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "user to security group mapping", + "description": "type of the icmp message being sent", "length": 255, - "name": "usersecuritygrouplist", + "name": "icmptype", "required": false, - "type": "map" + "type": "integer" }, { "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", @@ -136594,30 +139191,69 @@ "type": "uuid" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "end port for this ingress rule", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, {}, + { + "description": "the 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -136625,28 +139261,28 @@ "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -136655,13 +139291,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -136670,59 +139301,24 @@ "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", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - {}, - { - "description": "the 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" - } + {} ] }, { @@ -136742,43 +139338,53 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -136787,35 +139393,39 @@ "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { "description": "the host's currently allocated disk size", @@ -136823,84 +139433,75 @@ "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "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 nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, + {}, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the 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 ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, - {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" } ], @@ -136912,26 +139513,18 @@ "name": "updateBucket", "params": [ { - "description": "Enable/Disable Bucket encryption", + "description": "Bucket Quota in GB", "length": 255, - "name": "encryption", + "name": "quota", "required": false, - "type": "boolean" - }, - { - "description": "The ID of the Bucket", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Bucket Quota in GB", + "description": "Enable/Disable Bucket encryption", "length": 255, - "name": "quota", + "name": "encryption", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "Bucket Access Policy", @@ -136940,6 +139533,14 @@ "required": false, "type": "string" }, + { + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "Enable/Disable Bucket Versioning", "length": 255, @@ -136949,10 +139550,11 @@ } ], "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", @@ -136965,11 +139567,10 @@ "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" @@ -136979,14 +139580,6 @@ "isasync": false, "name": "updateResourceCount", "params": [ - { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": true, - "type": "uuid" - }, { "description": "Tag for the resource type", "length": 255, @@ -136995,6 +139588,13 @@ "since": "4.20.0", "type": "string" }, + { + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Update resource limits for project", "length": 255, @@ -137004,26 +139604,38 @@ "type": "uuid" }, { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "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": "resourcetype", - "required": false, - "type": "integer" + "name": "domainid", + "related": "listDomains", + "required": true, + "type": "uuid" }, { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "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": "account", + "name": "resourcetype", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "The resource count", - "name": "resourcecount", - "type": "long" + "description": "the domain name for which resource count's are updated", + "name": "domain", + "type": "string" + }, + { + "description": "the project name for which resource count's are updated", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the project id for which resource count's are updated", + "name": "projectid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -137036,21 +139648,15 @@ "type": "string" }, { - "description": "the account for which resource count's are updated", - "name": "account", - "type": "string" - }, - { - "description": "Tag for the resource", - "name": "tag", + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "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", @@ -137058,28 +139664,23 @@ }, {}, { - "description": "path of the domain to which the resource counts are updated", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { - "description": "the project name for which resource count's are updated", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", - "type": "string" + "description": "The resource count", + "name": "resourcecount", + "type": "long" }, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "description": "Tag for the resource", + "name": "tag", "type": "string" } ] @@ -137097,25 +139698,26 @@ "type": "string" }, { - "description": "List role by role name.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List role by role name.", "length": 255, - "name": "type", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "List role by role ID.", "length": 255, - "name": "page", + "name": "id", + "related": "listRoles", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List role by role type status, valid options are: enabled, disabled", @@ -137125,12 +139727,11 @@ "type": "string" }, { - "description": "List role by role ID.", + "description": "", "length": 255, - "name": "id", - "related": "listRoles", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -137143,26 +139744,21 @@ "related": "", "response": [ { - "description": "the name of the role", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, - {}, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the role", + "name": "state", "type": "string" }, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, {}, { "description": "the type of the role", @@ -137170,24 +139766,29 @@ "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": "the ID of the role", - "name": "id", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the description of the role", - "name": "description", + "description": "the ID of the role", + "name": "id", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" } ], "since": "4.9.0" @@ -137198,11 +139799,12 @@ "name": "listTungstenFabricPolicy", "params": [ { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of network", @@ -137213,12 +139815,11 @@ "type": "uuid" }, { - "description": "the ID of ip address", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "policyuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -137228,42 +139829,52 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "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", + "description": "the ID of ip address", "length": 255, - "name": "keyword", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, - {}, - {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", @@ -137274,21 +139885,11 @@ "name": "jobid", "type": "string" }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, { "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, {} ] }, @@ -137315,41 +139916,21 @@ ], "related": "extractSnapshot,extractTemplate", "response": [ - { - "description": "the id of extracted object", - "name": "id", - "type": "string" - }, { "description": "the upload id of extracted object", "name": "extractId", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "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": "", "name": "resultstring", "type": "string" }, - { - "description": "the state of the extracted object", - "name": "state", - "type": "string" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", - "type": "string" - }, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", @@ -137361,8 +139942,29 @@ "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "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": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { @@ -137370,20 +139972,20 @@ "name": "extractMode", "type": "string" }, - {}, { "description": "the status of the extraction", "name": "status", "type": "string" }, + {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -137392,11 +139994,10 @@ "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" - }, - {} + } ], "since": "4.19.0" }, @@ -137421,27 +140022,27 @@ "name": "userid", "type": "string" }, - {}, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "the cloud identifier", + "name": "cloudidentifier", "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 signed response for the cloud identifier", + "name": "signature", + "type": "string" }, {}, { - "description": "the cloud identifier", - "name": "cloudidentifier", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -137450,28 +140051,6 @@ "isasync": true, "name": "createLBStickinessPolicy", "params": [ - { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "the ID of the load balancer rule", "length": 255, @@ -137480,6 +140059,13 @@ "required": true, "type": "uuid" }, + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, @@ -137493,13 +140079,29 @@ "name": "param", "required": false, "type": "map" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the description of the load balancer stickiness policy", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -137508,59 +140110,22 @@ "type": "integer" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness 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 of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, - {}, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, { "description": "the params of the policy", "name": "params", "type": "map" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the state of the policy", + "name": "state", "type": "string" }, { @@ -137569,19 +140134,24 @@ "type": "boolean" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" } ], "type": "list" @@ -137590,6 +140160,37 @@ "description": "the state of the policy", "name": "state", "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -137600,10 +140201,10 @@ "name": "addCiscoAsa1000vResource", "params": [ { - "description": "the Physical Network ID", + "description": "the Cluster ID", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "clusterid", + "related": "addCluster", "required": true, "type": "uuid" }, @@ -137615,19 +140216,19 @@ "type": "string" }, { - "description": "the Cluster ID", + "description": "Nexus port profile associated with inside interface of ASA 1000v", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "insideportprofile", "required": true, - "type": "uuid" + "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" } ], "related": "", @@ -137641,13 +140242,13 @@ {}, {}, {}, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, {} ] }, @@ -137656,13 +140257,6 @@ "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, @@ -137670,44 +140264,41 @@ "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": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "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 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": "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": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { @@ -137716,29 +140307,30 @@ "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" }, { "description": "device capacity", @@ -137746,24 +140338,33 @@ "type": "long" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + { + "description": "device state", + "name": "fwdevicestate", "type": "string" } ] @@ -137774,19 +140375,19 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "customid", + "name": "number", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the ending port of ACL", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "endport", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "type of the ICMP message being sent", @@ -137796,31 +140397,23 @@ "type": "integer" }, { - "description": "scl entry action, allow or deny", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "action", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "scl entry action, allow or deny", "length": 255, - "name": "fordisplay", + "name": "action", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "protocol", + "name": "reason", "required": false, "type": "string" }, @@ -137832,63 +140425,121 @@ "type": "boolean" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the starting port of ACL", "length": 255, - "name": "traffictype", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this ICMP message", + "description": "the ID of the network ACL item", "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" }, { - "description": "The network of the vm the ACL will be created for", + "description": "the ending port of ACL", "length": 255, - "name": "number", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the ID of the network ACL item", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the starting port of ACL", + "description": "error code for this ICMP message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "reason", + "name": "customid", + "required": false, + "since": "4.4", + "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": false, "type": "string" } ], "related": "moveNetworkAclItem", "response": [ + { + "description": "the state of the rule", + "name": "state", + "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": "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", + "type": "string" + }, { "description": "the protocol of the ACL", "name": "protocol", "type": "string" }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -137897,8 +140548,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -137907,124 +140558,74 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "resource type", - "name": "resourcetype", + "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" } ], "type": "list" }, - {}, { - "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": "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 starting port of ACL's port range", - "name": "startport", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "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", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, + {}, { "description": "the ID of the ACL this item belongs to", "name": "aclid", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" } ] }, @@ -138034,34 +140635,32 @@ "name": "listRouters", "params": [ { - "description": "the Zone ID of the router", + "description": "CPU arch of the router", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.1", + "type": "string" }, { - "description": "the host ID of the router", + "description": "list virtual router elements by version", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "version", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "the name of the router", "length": 255, - "name": "healthchecksfailed", + "name": "name", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "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" }, @@ -138074,19 +140673,33 @@ "type": "boolean" }, { - "description": "List networks by VPC", + "description": "List by keyword", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "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" }, { - "description": "the state 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": "state", + "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 account. Must be used with the domainId parameter.", @@ -138096,33 +140709,35 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the host ID of the router", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "hostid", + "related": "reconnectHost", "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 networks by VPC", "length": 255, - "name": "isrecursive", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the router", + "description": "list by network id", "length": 255, - "name": "name", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the disk router", @@ -138133,48 +140748,50 @@ "type": "uuid" }, { - "description": "list virtual router elements by version", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "version", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "forvpc", + "name": "healthchecksfailed", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "", + "description": "the state of the router", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the cluster ID of the router", + "description": "the Pod ID of the router", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 Zone ID of the router", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -138182,51 +140799,78 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "the Pod ID of the router", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -138235,49 +140879,135 @@ "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 guest IP address for the router", - "name": "guestipaddress", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, { "description": "the guest netmask for the router", "name": "guestnetmask", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { @@ -138285,24 +141015,34 @@ "name": "nic", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "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 netmask of the nic", @@ -138310,14 +141050,19 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "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": "public IP address associated with this nic via Static nat rule", @@ -138325,19 +141070,14 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { "description": "MTU configured on the NIC", @@ -138345,33 +141085,28 @@ "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -138380,28 +141115,28 @@ "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -138410,255 +141145,134 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "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 date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "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 second DNS for the router", "name": "dns2", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - {}, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "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 first IPv6 DNS for the router", + "name": "ip6dns1", "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", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "role of the domain router", - "name": "role", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the UUID of the latest async job acting on 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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "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 name of the health check on the router", "name": "checkname", "type": "string" }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, { "description": "result of the health check", "name": "success", "type": "boolean" }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, { "description": "detailed response generated on running health check", "name": "details", "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" } ], "type": "list" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" } ] }, @@ -138675,53 +141289,43 @@ "type": "string" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "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": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric vm name", - "name": "name", + "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 nic uuid", "name": "uuid", @@ -138732,10 +141336,20 @@ "name": "zoneid", "type": "long" }, + { + "description": "Tungsten-Fabric vm name", + "name": "name", + "type": "string" + }, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -138755,28 +141369,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "3.0.0" }, @@ -138786,108 +141400,108 @@ "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "Tungsten-Fabric policy rule source end port", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "srcendport", + "name": "destnetwork", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "srcstartport", + "name": "destipprefix", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "destipprefix", + "name": "destipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "protocol", + "name": "srcstartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "Tungsten-Fabric policy rule source end port", "length": 255, - "name": "destendport", + "name": "srcendport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source network", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "srcnetwork", + "name": "protocol", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination network", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "destnetwork", + "name": "policyuuid", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix length", + "description": "Tungsten-Fabric policy rule destination start port", "length": 255, - "name": "srcipprefixlen", + "name": "deststartport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "destipprefixlen", + "name": "destendport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "deststartport", + "name": "srcipprefix", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, - "name": "direction", + "name": "srcipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy rule action", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "action", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule source network", "length": 255, - "name": "srcipprefix", + "name": "srcnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "action", + "name": "direction", "required": true, "type": "string" } @@ -138895,34 +141509,38 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", "type": "int" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, - {}, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { @@ -138931,29 +141549,30 @@ "type": "int" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "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", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { "description": "Tungsten-Fabric policy source ip prefix", @@ -138961,36 +141580,31 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" - }, - {} + } ] }, { @@ -138999,11 +141613,11 @@ "name": "createWebhook", "params": [ { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "Payload URL of the Webhook", "length": 255, - "name": "sslverification", - "required": false, - "type": "boolean" + "name": "payloadurl", + "required": true, + "type": "string" }, { "description": "Project for the Webhook", @@ -139014,9 +141628,16 @@ "type": "uuid" }, { - "description": "Description for the Webhook", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "description", + "name": "sslverification", + "required": false, + "type": "boolean" + }, + { + "description": "State of the Webhook", + "length": 255, + "name": "state", "required": false, "type": "string" }, @@ -139029,9 +141650,9 @@ "type": "uuid" }, { - "description": "An optional account for the Webhook. Must be used with domainId.", + "description": "Description for the Webhook", "length": 255, - "name": "account", + "name": "description", "required": false, "type": "string" }, @@ -139050,57 +141671,35 @@ "type": "string" }, { - "description": "Payload URL of the Webhook", - "length": 255, - "name": "payloadurl", - "required": true, - "type": "string" - }, - { - "description": "State of the Webhook", + "description": "Secret key of the Webhook", "length": 255, - "name": "state", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "Secret key of the Webhook", + "description": "An optional account for the Webhook. Must be used with domainId.", "length": 255, - "name": "secretkey", + "name": "account", "required": false, "type": "string" } ], "related": "", "response": [ - { - "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", - "type": "string" - }, { "description": "the project id of the Kubernetes cluster", "name": "projectid", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", - "type": "string" - }, - { - "description": "The account associated with the Webhook", - "name": "account", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { @@ -139109,9 +141708,9 @@ "type": "string" }, { - "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" }, { "description": "The ID of the domain in which the Webhook exists", @@ -139119,13 +141718,18 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The description of the Webhook", + "name": "description", + "type": "string" + }, + { + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { @@ -139134,19 +141738,19 @@ "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, {}, { @@ -139155,11 +141759,21 @@ "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "The ID of the Webhook", + "name": "id", + "type": "string" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The name of the Webhook", + "name": "name", + "type": "string" + } ], "since": "4.20.0" }, @@ -139168,6 +141782,13 @@ "isasync": true, "name": "removeVpnUser", "params": [ + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -139183,13 +141804,6 @@ "required": true, "type": "string" }, - { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "remove vpn user from the project", "length": 255, @@ -139200,27 +141814,27 @@ } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "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" } ] }, @@ -139229,6 +141843,20 @@ "isasync": false, "name": "listQuarantinedIps", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -139249,38 +141877,38 @@ "name": "showinactive", "required": false, "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "updateQuarantinedIp", "response": [ { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" }, { "description": "Account name of the previous public IP address owner.", "name": "previousownername", "type": "string" }, - {}, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { @@ -139288,7 +141916,6 @@ "name": "removed", "type": "date" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -139299,31 +141926,18 @@ "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": "End date for the quarantine.", - "name": "enddate", - "type": "date" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - } + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + {} ], "since": "4.19" }, @@ -139348,80 +141962,24 @@ "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.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 HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], - "since": "4.11" + "since": "4.2.0" }, { "description": "List Swift.", @@ -139435,13 +141993,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the id of the swift", "length": 255, @@ -139455,31 +142006,59 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the image store", + "name": "url", "type": "string" }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, { "description": "the Zone name of the image store", "name": "zonename", @@ -139495,44 +142074,79 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" + } + ], + "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "if host HA is enabled for the host", + "name": "haenable", + "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 ID of the image store", - "name": "zoneid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the host", + "name": "hostid", "type": "string" - } + }, + {} ], - "since": "3.0.0" + "since": "4.11" }, { "description": "Enables out-of-band management for a host", @@ -139550,30 +142164,35 @@ ], "related": "", "response": [ + {}, { "description": "the operation result description", "name": "description", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the 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 ID of the host", "name": "hostid", "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" }, { @@ -139581,40 +142200,35 @@ "name": "powerstate", "type": "powerstate" }, - { - "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 action (if issued)", "name": "action", "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", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface username", + "name": "username", "type": "string" } ], @@ -139635,28 +142249,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the 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" - } + {} ] }, { @@ -139665,31 +142279,34 @@ "name": "listKubernetesSupportedVersions", "params": [ { - "description": "", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of the minimum Kubernetes supported version", "length": 255, - "name": "pagesize", + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" }, { - "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" }, { @@ -139701,111 +142318,121 @@ "type": "uuid" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "List by keyword", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "length": 255, + "name": "minimumsemanticversion", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "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": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, + {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "Name of the Kubernetes supported version", + "name": "name", "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 arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -139814,9 +142441,9 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" }, @@ -139827,6 +142454,14 @@ "required": false, "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, @@ -139835,20 +142470,12 @@ "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "username", + "name": "transportzoneuuid", "required": true, "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "Credentials to access the Nicira Controller API", "length": 255, @@ -139857,9 +142484,9 @@ "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "transportzoneuuid", + "name": "hostname", "required": true, "type": "string" } @@ -139867,14 +142494,8 @@ "related": "", "response": [ { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" - }, - {}, - { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { @@ -139883,23 +142504,24 @@ "type": "integer" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "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" }, { @@ -139908,16 +142530,21 @@ "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, + {}, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -139933,75 +142560,75 @@ "type": "integer" }, {}, - {}, { - "description": "Number of clusters", - "name": "clusters", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of pods", + "name": "pods", "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "description": "Number of object stores", + "name": "objectstores", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "Number of routers", + "name": "routers", "type": "integer" }, { - "description": "Number of object stores", - "name": "objectstores", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { - "description": "Number of systemvms", - "name": "systemvms", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Number of zones", + "name": "zones", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ], @@ -140013,34 +142640,33 @@ "name": "listUsageRecords", "params": [ { - "description": "Flag to enable display of Tags for a resource", + "description": "Start date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "includetags", - "required": false, - "type": "boolean" + "name": "startdate", + "required": true, + "type": "date" }, { - "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" }, { - "description": "List by keyword", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "keyword", + "name": "includetags", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List usage records for specified project", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "usageid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List usage records for the specified usage type", @@ -140052,44 +142678,53 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List usage records for the specified user.", + "description": "List usage records for the specified domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Start date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "name": "oldformat", + "required": false, + "type": "boolean" }, { - "description": "List usage records for the specified account", + "description": "List usage records for specified project", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "List usage records for the specified user.", "length": 255, - "name": "usageid", + "name": "account", "required": false, "type": "string" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "List by keyword", "length": 255, - "name": "oldformat", + "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" }, { @@ -140102,51 +142737,115 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - }, - { - "description": "List usage records for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "resource size", - "name": "size", + "description": "template ID", + "name": "templateid", + "type": "string" + }, + {}, + { + "description": "offering ID", + "name": "offeringid", + "type": "string" + }, + { + "description": "virtual machine os display name", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the user account Id", + "name": "accountid", + "type": "string" + }, + { + "description": "the project id of the resource", + "name": "projectid", + "type": "string" + }, + { + "description": "usage type ID", + "name": "usagetype", + "type": "integer" + }, + { + "description": "description of the usage record", + "name": "description", + "type": "string" + }, + { + "description": "end date of the usage record", + "name": "enddate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "type", + "type": "string" + }, + { + "description": "virtual size of resource", + "name": "virtualsize", "type": "long" }, { - "description": "True if the resource is default", - "name": "isdefault", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", "type": "boolean" }, { - "description": "the domain the resource is associated with", - "name": "domain", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "start date of the usage record", - "name": "startdate", - "type": "date" + "description": "id of the resource", + "name": "usageid", + "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "usage in hours", + "name": "usage", "type": "string" }, + { + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", + "type": "boolean" + }, + {}, { "description": "memory allocated for the resource", "name": "memory", @@ -140162,33 +142861,33 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -140197,148 +142896,76 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", - "type": "string" + "description": "resource size", + "name": "size", + "type": "long" }, { - "description": "the domain ID", - "name": "domainid", - "type": "string" + "description": "start date of the usage record", + "name": "startdate", + "type": "date" }, { - "description": "template ID", - "name": "templateid", + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the resource", + "name": "project", + "type": "string" }, { "description": "raw usage in hours", "name": "rawusage", "type": "string" }, - {}, - { - "description": "virtual machine os display name", - "name": "osdisplayname", - "type": "string" - }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", - "type": "date" - }, - { - "description": "resource type", - "name": "type", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, - { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" - }, { "description": "number of cpu of resource", "name": "cpunumber", "type": "long" }, { - "description": "the project id of the resource", - "name": "projectid", - "type": "string" - }, - { - "description": "offering ID", - "name": "offeringid", - "type": "string" - }, - { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "usage in hours", - "name": "usage", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "id of the network", - "name": "networkid", - "type": "string" - }, - { - "description": "the project name of the resource", - "name": "project", - "type": "string" - }, - {}, - { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", + "description": "True if the resource is default", + "name": "isdefault", "type": "boolean" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the user account Id", - "name": "accountid", - "type": "string" - }, - { - "description": "the zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "id of the vpc", - "name": "vpcid", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "description of the usage record", - "name": "description", + "description": "the user account name", + "name": "account", "type": "string" }, { @@ -140347,24 +142974,24 @@ "type": "string" }, { - "description": "the user account name", - "name": "account", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "path of the domain to which the usage reocrd belongs", - "name": "domainpath", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" } ] }, @@ -140385,174 +143012,179 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "state of the virtual machine", - "name": "vmstate", - "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", + "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", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "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 ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "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 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": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "size of the disk volume", + "name": "size", + "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": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "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 domain associated with the disk volume", - "name": "domain", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { @@ -140560,53 +143192,53 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -140618,48 +143250,49 @@ "type": "set" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the project name of the vpn", + "name": "project", "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": "min iops of the disk volume", - "name": "miniops", - "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": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -140668,125 +143301,109 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "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 format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "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 VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { "description": "details for the volume check result, they may vary for different hypervisors", @@ -140794,19 +143411,29 @@ "type": "map" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" } ], "since": "4.14.0" @@ -140816,13 +143443,6 @@ "isasync": true, "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ - { - "description": "Tungsten-Fabric logical router uuid", - "length": 255, - "name": "logicalrouteruuid", - "required": true, - "type": "string" - }, { "description": "Tungsten-Fabric network uuid", "length": 255, @@ -140837,10 +143457,22 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" } ], "related": "", "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric logical router uuid", "name": "uuid", @@ -140849,14 +143481,19 @@ {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "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 logical router name", @@ -140867,16 +143504,6 @@ "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" } ] }, @@ -140888,16 +143515,16 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the path of the volume on the storage pool", + "description": "", "length": 255, - "name": "path", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the storage pool", @@ -140908,66 +143535,62 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the path of the volume on the storage pool", "length": 255, - "name": "keyword", + "name": "path", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "name of the primary storage hosting the volume", - "name": "storage", + "description": "the encrypt format of the volume", + "name": "encryptformat", "type": "string" }, { - "description": "volume details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the size of the volume", + "name": "size", + "type": "long" }, - {}, { "description": "type of the primary storage hosting the volume", "name": "storagetype", "type": "string" }, { - "description": "the size of the volume", - "name": "size", - "type": "long" - }, - { - "description": "id of the primary storage hosting the volume", - "name": "storageid", + "description": "the full path of the volume", + "name": "fullpath", "type": "string" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the full path of the volume", - "name": "fullpath", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the encrypt format of the volume", - "name": "encryptformat", + "description": "id of the primary storage hosting the volume", + "name": "storageid", "type": "string" }, { @@ -140975,15 +143598,14 @@ "name": "virtualsize", "type": "long" }, - {}, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the format of the volume", - "name": "format", + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -140992,8 +143614,13 @@ "type": "integer" }, { - "description": "the name of the volume", - "name": "name", + "description": "name of the primary storage hosting the volume", + "name": "storage", + "type": "string" + }, + { + "description": "the format of the volume", + "name": "format", "type": "string" } ], @@ -141005,34 +143632,33 @@ "name": "listZonesMetrics", "params": [ { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "", "length": 255, - "name": "networktype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the zone", + "description": "", "length": 255, - "name": "id", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "flag to display the resource image for the zones", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "showicon", + "name": "networktype", "required": false, - "type": "boolean" + "type": "string" }, { - "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": "flag to display the capacity of the zones", @@ -141042,210 +143668,180 @@ "type": "boolean" }, { - "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": "listZones", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "list" }, { - "description": "the name of the zone", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "name", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the domain associated with the zone", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "the ID of the zone", "length": 255, - "name": "ids", + "name": "id", "related": "listZones", "required": false, - "since": "4.19.0", - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "the name of the zone", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "keyword", + "name": "available", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "since": "4.3", + "type": "map" } ], "related": "", "response": [ { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" }, + {}, { - "description": "the list of resource tags associated with zone.", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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 UUID of the containing domain, null for public zones", + "name": "domainid", + "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 second internal DNS for the Zone", - "name": "internaldns2", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { @@ -141254,23 +143850,68 @@ "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, { - "description": "Zone Token", - "name": "zonetoken", + "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", + "type": "integer" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -141278,116 +143919,91 @@ "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, { "description": "the Pod ID", "name": "podid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { "description": "the capacity type", "name": "type", "type": "short" }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" } ], "type": "list" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { @@ -141395,91 +144011,107 @@ "name": "isnsxenabled", "type": "boolean" }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, { "description": "the total cpu capacity in Ghz", "name": "cputotal", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" - }, - {}, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "Zone id", + "name": "id", "type": "string" }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - {}, { "description": "the second IPv6 DNS for the Zone", "name": "ip6dns2", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, + {}, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" } ], @@ -141506,36 +144138,26 @@ "type": "string" }, { - "description": "the ID of the template", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "mode", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ID of the template", "length": 255, - "name": "mode", + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, - "type": "string" + "type": "uuid" } ], "related": "extractSnapshot", "response": [ { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - }, - { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, - { - "description": "", - "name": "resultstring", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { @@ -141544,29 +144166,34 @@ "type": "integer" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the percentage of the entity uploaded to the specified location", @@ -141574,37 +144201,42 @@ "type": "integer" }, { - "description": "the status of the extraction", - "name": "status", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, + {}, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "", + "name": "resultstring", "type": "string" }, - {}, - {}, { "description": "the id of extracted object", "name": "id", "type": "string" - } + }, + { + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + {} ] }, { @@ -141622,11 +144254,6 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -141638,6 +144265,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "any text associated with the success or failure", @@ -141659,14 +144291,6 @@ "since": "4.4", "type": "string" }, - { - "description": "the ID of the public IP address to update", - "length": 255, - "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, @@ -141674,95 +144298,163 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "the ID of the public IP address to update", + "length": 255, + "name": "id", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "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 domain the public IP address is associated with", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "list" }, { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "public IP address", + "name": "ipaddress", + "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": "public IP address id", - "name": "id", - "type": "string" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { @@ -141771,33 +144463,43 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "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", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "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 System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { @@ -141806,131 +144508,61 @@ "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, + {}, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "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 ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "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": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" - }, - { - "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" } ] }, @@ -141940,18 +144572,18 @@ "name": "migrateNetwork", "params": [ { - "description": "the ID of the network", + "description": "network offering ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "networkofferingid", + "related": "", "required": true, "type": "uuid" }, { - "description": "network offering ID", + "description": "the ID of the network", "length": 255, - "name": "networkofferingid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" }, @@ -141966,534 +144598,539 @@ "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 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" - } - ], - "type": "list" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, - {}, { "description": "true if network is system, false otherwise", "name": "issystem", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "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": "ip4routes", - "type": "set" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the physical network id", + "name": "physicalnetworkid", "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 sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "state of the network", - "name": "state", + "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": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", "type": "set" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "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": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the name of the network", - "name": "name", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, + {}, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the network's netmask", - "name": "netmask", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "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", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "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 network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, { "description": "an optional field, whether to the display the network to the end user or not.", "name": "displaynetwork", "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "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", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "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": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service 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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "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": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + {}, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, - {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { "description": "true network requires restart", "name": "restartrequired", "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" } ], "since": "4.11.0" @@ -142504,18 +145141,12 @@ "name": "listUnmanagedInstances", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "the cluster ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { "description": "the hypervisor name of the instance", @@ -142532,80 +145163,40 @@ "type": "string" }, { - "description": "the cluster ID", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "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", - "type": "string" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - {}, - { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" - }, + } + ], + "related": "", + "response": [ { "description": "the list of nics associated with the virtual machine", "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "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", - "name": "traffictype", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "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": "public IP address id associated with this nic via Static nat rule", @@ -142613,23 +145204,23 @@ "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -142638,43 +145229,63 @@ "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", + "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 isolated private VLAN type if available", "name": "isolatedpvlantype", "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": "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 traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -142683,23 +145294,23 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -142708,19 +145319,14 @@ "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", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -142728,37 +145334,61 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, - {}, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, { "description": "the CPU cores of the virtual machine", "name": "cpunumber", "type": "integer" }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "indicates the boot type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, { "description": "the list of disks associated with the virtual machine", "name": "disk", "response": [ { - "description": "the 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": "datastorehost", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "the ID of the disk", + "name": "id", + "type": "string" }, { "description": "the controller of the disk", @@ -142767,52 +145397,68 @@ }, { "description": "the controller of the disk", - "name": "datastoretype", + "name": "datastorehost", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the ID of the disk", - "name": "id", - "type": "string" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "the label of the disk", - "name": "label", + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", + "description": "the position of the disk", + "name": "position", "type": "integer" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the label of the disk", + "name": "label", "type": "string" } ], "type": "set" }, + {}, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, { "description": "the CPU speed of the virtual machine", "name": "cpuspeed", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, + { + "description": "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", + "type": "string" + }, { "description": "the ID of the host to which virtual machine belongs", "name": "hostid", @@ -142824,20 +145470,21 @@ "type": "string" }, { - "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 name of the host to which virtual machine belongs", - "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", + "description": "indicates the boot mode", + "name": "bootmode", "type": "string" - } + }, + {} ], "since": "4.14.0" }, @@ -142847,61 +145494,52 @@ "name": "registerTemplate", "params": [ { - "description": "the target hypervisor for the template", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "the name of the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "zoneids", - "related": "listZones", + "name": "deployasis", "required": false, - "type": "list" + "since": "4.15.1", + "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "arch", + "name": "checksum", "required": false, - "since": "4.20", "type": "string" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "description": "the name of the template", + "length": 255, + "name": "name", "required": true, "type": "string" }, @@ -142913,93 +145551,85 @@ "type": "boolean" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "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": "Register template for the project", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "projectid", - "related": "", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "passwordenabled", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "sshkeyenabled", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isextractable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "the target hypervisor for the template", "length": 255, - "name": "format", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "bits", + "name": "isfeatured", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "templatetag", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "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": "templatetype", + "name": "zoneids", + "related": "listZones", "required": false, - "since": "4.19.0", - "type": "string" + "type": "list" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "isfeatured", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "an optional accountName. Must be used with domainId.", @@ -143016,17 +145646,27 @@ "type": "map" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "ispublic", + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "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": "checksum", + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { @@ -143037,54 +145677,56 @@ "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "directdownload", + "name": "isextractable", "required": false, "type": "boolean" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" } ], "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the template ID", - "name": "id", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "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": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "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": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { "description": "the name of the domain to which the template belongs", @@ -143092,44 +145734,111 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "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": "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 physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", @@ -143137,252 +145846,190 @@ "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "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", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the type of the template", + "name": "templatetype", "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "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": "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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "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 ID of the zone for this template", - "name": "zoneid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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 size of the template", - "name": "size", - "type": "long" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the template ID", + "name": "id", "type": "string" } ] @@ -143393,38 +146040,42 @@ "name": "listVnfAppliances", "params": [ { - "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": "the ID of AutoScaling VM Group", + "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": "autoscalevmgroupid", - "related": "", + "name": "isvnf", "required": false, - "since": "4.18.0", - "type": "uuid" + "since": "4.19.0", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the security group ID", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "haenable", "required": false, "since": "4.15", - "type": "uuid" + "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.", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", @@ -143434,79 +146085,115 @@ "type": "string" }, { - "description": "flag to display the resource icon for VMs", + "description": "", "length": 255, - "name": "showicon", + "name": "page", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "integer" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by iso", "length": 255, - "name": "forvirtualnetwork", + "name": "isoid", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list by the service offering", "length": 255, - "name": "listall", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "list by the backup offering", "length": 255, - "name": "affinitygroupid", + "name": "backupofferingid", "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the group ID", "length": 255, - "name": "haenable", + "name": "groupid", + "related": "", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "the instances by userdata", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "userdataid", + "related": "", "required": false, + "since": "4.20.1", "type": "uuid" }, { - "description": "list vms by iso", + "description": "list vms by affinity group", "length": 255, - "name": "isoid", + "name": "affinitygroupid", + "related": "", "required": false, "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": "makes the API's response contains only the resource count", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "displayvm", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" + }, + { + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" }, { "description": "list vms by vpc", @@ -143517,41 +146204,42 @@ "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": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "tags", + "name": "forvirtualnetwork", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "CPU arch of the VM", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "arch", "required": false, - "since": "4.4", - "type": "list" + "since": "4.20.1", + "type": "string" }, { - "description": "the target hypervisor for the template", + "description": "the availability zone ID", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the user ID that created the VM and is under the account that owns the VM", @@ -143562,18 +146250,20 @@ "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "keypair", + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "since": "4.4", + "type": "list" }, { - "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 account. Must be used with the domainId parameter.", @@ -143583,52 +146273,36 @@ "type": "string" }, { - "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": "the group ID", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "groupid", + "name": "autoscalevmgroupid", "related": "", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "the availability zone ID", + "description": "list by network id", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "projectid", - "related": "", + "name": "showicon", "required": false, - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "userdata", + "name": "keypair", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "string" }, { "description": "list vms by template", @@ -143639,243 +146313,333 @@ "type": "uuid" }, { - "description": "list by the backup offering", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "backupofferingid", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.17", - "type": "uuid" + "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": "the target hypervisor for the template", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "list by the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "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": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "details", + "name": "userdata", "required": false, - "type": "list" + "since": "4.18.0.0", + "type": "boolean" } ], "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "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", + "type": "string" + }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + {}, + {}, + { + "description": "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "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", - "response": [ + }, { - "description": "the type of the affinity group", + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "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" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { "description": "State of the Service from LB rule", @@ -143883,148 +146647,238 @@ "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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 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": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "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": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -144032,76 +146886,26 @@ "name": "securitygroup", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the 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 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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -144110,49 +146914,109 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "set" + }, + { + "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 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 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 id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -144160,28 +147024,68 @@ "name": "account", "type": "string" }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -144189,8 +147093,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -144199,103 +147103,83 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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 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": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -144309,23 +147193,23 @@ "type": "string" }, { - "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -144334,353 +147218,134 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "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 domain name of the security group", - "name": "domain", - "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 domain ID of the security group", - "name": "domainid", - "type": "string" } ], "type": "set" }, - {}, - { - "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": "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 backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the 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 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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "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 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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "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 VM's primary IP address", + "name": "ipaddress", "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Base64 string containing the user data", + "name": "userdata", "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" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Guest vm Boot Type", + "name": "boottype", "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": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -144689,54 +147354,59 @@ "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "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": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "VNF details", @@ -144744,23 +147414,23 @@ "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "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 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 account associated with the virtual machine", - "name": "account", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" } ], @@ -144771,13 +147441,6 @@ "isasync": false, "name": "addStratosphereSsp", "params": [ - { - "description": "stratosphere ssp api name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "stratosphere ssp api username", "length": 255, @@ -144792,6 +147455,13 @@ "required": true, "type": "string" }, + { + "description": "stratosphere ssp api name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "stratosphere ssp api password", "length": 255, @@ -144799,6 +147469,13 @@ "required": false, "type": "string" }, + { + "description": "stratosphere ssp tenant uuid", + "length": 255, + "name": "tenantuuid", + "required": false, + "type": "string" + }, { "description": "the zone ID", "length": 255, @@ -144806,49 +147483,42 @@ "related": "listZones", "required": true, "type": "uuid" - }, - { - "description": "stratosphere ssp tenant uuid", - "length": 255, - "name": "tenantuuid", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "zone which this ssp controls", - "name": "zoneid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name", - "name": "name", + "description": "zone which this ssp controls", + "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": "server id of the stratosphere ssp server", + "name": "hostid", + "type": "string" }, { - "description": "url of ssp endpoint", - "name": "url", + "description": "name", + "name": "name", "type": "string" - }, - {} + } ] }, { @@ -144857,18 +147527,18 @@ "name": "createStoragePool", "params": [ { - "description": "the storage provider name", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "provider", + "name": "capacitybytes", "required": false, - "type": "string" + "type": "long" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the storage provider name", "length": 255, - "name": "capacityiops", + "name": "provider", "required": false, - "type": "long" + "type": "string" }, { "description": "whether the storage should be managed by CloudStack", @@ -144878,19 +147548,18 @@ "type": "boolean" }, { - "description": "the details for the storage pool", + "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", "length": 255, - "name": "details", + "name": "hypervisor", "required": false, - "type": "map" + "type": "string" }, { - "description": "the cluster ID for the storage pool", + "description": "the name for the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "the scope of the storage: cluster or zone", @@ -144900,12 +147569,11 @@ "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "the tags for the storage pool", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "tags", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the Zone ID for the storage pool", @@ -144916,18 +147584,19 @@ "type": "uuid" }, { - "description": "the tags for the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "tags", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name for the storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { "description": "the URL of the storage pool", @@ -144937,16 +147606,17 @@ "type": "string" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "hypervisor", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "capacitybytes", + "name": "capacityiops", "required": false, "type": "long" }, @@ -144961,8 +147631,13 @@ "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -144971,29 +147646,34 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the 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": "true if this pool is suitable to migrate a volume, false otherwise", @@ -145001,65 +147681,64 @@ "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "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 capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "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 name of the storage pool", - "name": "name", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "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", - "type": "boolean" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, - {}, - {}, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -145068,59 +147747,55 @@ "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the 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": "the ID of the cluster for the storage pool", - "name": "clusterid", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" } ] }, @@ -145129,13 +147804,6 @@ "isasync": false, "name": "findStoragePoolsForMigration", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -145143,6 +147811,14 @@ "required": false, "type": "integer" }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -145151,34 +147827,43 @@ "type": "integer" }, { - "description": "the ID of the volume", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "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 storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -145186,39 +147871,51 @@ "name": "type", "type": "string" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { "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 host's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { @@ -145227,101 +147924,84 @@ "type": "string" }, { - "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 storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, { "description": "the Zone name of the storage pool", "name": "zonename", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -145331,39 +148011,39 @@ "name": "deleteTungstenFabricFirewallRule", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "firewallruleuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "the ID of zone", "length": 255, - "name": "firewallruleuuid", + "name": "zoneid", + "related": "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": "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", @@ -145387,16 +148067,6 @@ ], "related": "listCiscoNexusVSMs", "response": [ - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" - }, - { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, { "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", "name": "ipaddress", @@ -145404,60 +148074,70 @@ }, {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, { "description": "The mode of the VSM (standalone/HA)", "name": "vsmconfigmode", "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": "device name", "name": "vsmdevicename", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" }, - {}, { "description": "storage vlan id of the VSM", "name": "vsmstoragevlanid", "type": "int" }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, { "description": "The Device State (Enabled/Disabled) of the VSM", "name": "vsmdevicestate", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { "description": "The Config State (Primary/Standby) of the VSM", "name": "vsmconfigstate", "type": "string" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "type": "string" - }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" } ] }, @@ -145467,33 +148147,33 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "the netmask for storage network", + "description": "the beginning IP address", "length": 255, - "name": "netmask", + "name": "startip", "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", - "required": true, - "type": "uuid" + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the beginning IP address", + "description": "the netmask for storage network", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "vlan", - "required": false, - "type": "integer" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { "description": "the gateway for storage network", @@ -145503,70 +148183,70 @@ "type": "string" }, { - "description": "the ending IP address", + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", "length": 255, - "name": "endip", + "name": "vlan", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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 uuid of storage network IP range.", - "name": "id", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, + {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" } ], @@ -145596,19 +148276,19 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project id of the ipaddress", @@ -145616,42 +148296,42 @@ "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, { "description": "Enabled/Disabled the service provider", "name": "enabled", "type": "boolean" }, - { - "description": "the id of the ovs", - "name": "id", - "type": "string" - }, + {}, { "description": "path of the domain to which the provider belongs", "name": "domainpath", "type": "string" }, - {}, - {}, { "description": "the project name of the address", "name": "project", "type": "string" - } + }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" + }, + {} ] }, { @@ -145660,18 +148340,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": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { "description": "the IDs of the system VMs, mutually exclusive with id.", @@ -145682,11 +148362,19 @@ "type": "list" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the ID of the system VM.", "length": 255, - "name": "startdate", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "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": "name", "required": false, - "type": "date" + "type": "string" }, { "description": "", @@ -145695,14 +148383,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of the system VM.", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": false, - "type": "uuid" - }, { "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, @@ -145711,46 +148391,46 @@ "type": "date" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "type": "string" }, - {}, - {}, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job 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 virtual machine", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { "description": "the list of VM stats", "name": "stats", "type": "list" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" } ], "since": "4.18.0" @@ -145770,27 +148450,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": "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" + }, + {}, {} ] }, @@ -145799,6 +148479,20 @@ "isasync": true, "name": "createFirewallRule", "params": [ + { + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, @@ -145814,6 +148508,14 @@ "since": "4.4", "type": "boolean" }, + { + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, { "description": "type of firewallrule: system/user", "length": 255, @@ -145822,9 +148524,16 @@ "type": "string" }, { - "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": "the ending port of firewall rule", + "length": 255, + "name": "endport", "required": false, "type": "integer" }, @@ -145834,66 +148543,93 @@ "name": "cidrlist", "required": false, "type": "list" + } + ], + "related": "updateEgressFirewallRule", + "response": [ + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, + "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", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "type of the ICMP message being sent", - "length": 255, + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {}, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "type of the icmp message being sent", "name": "icmptype", - "required": false, "type": "integer" }, - { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "related": "updateEgressFirewallRule", - "response": [ { "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": "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -145902,68 +148638,46 @@ "type": "string" }, { - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project 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" } ], "type": "list" }, - { - "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 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 protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - {}, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { @@ -145976,41 +148690,7 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the 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": "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 ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - } + {} ] }, { @@ -146019,31 +148699,32 @@ "name": "createVolume", "params": [ { - "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 availability zone", "length": 255, - "name": "customid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "description": "Arbitrary volume size", "length": 255, - "name": "snapshotid", - "related": "listSnapshots", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "account", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -146055,48 +148736,40 @@ "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": "the name of the disk volume", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the availability zone", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "min iops", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" - }, - { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "projectid", - "related": "", + "name": "snapshotid", + "related": "listSnapshots", "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.", + "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": "domainid", - "related": "listDomains", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "Arbitrary volume size", + "description": "min iops", "length": 255, - "name": "size", + "name": "miniops", "required": false, "type": "long" }, @@ -146108,10 +148781,17 @@ "type": "long" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "customid", + "required": false, + "type": "string" + }, + { + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" } @@ -146119,116 +148799,54 @@ "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "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": "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": "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": "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "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", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { "description": "cluster id of the volume", @@ -146236,89 +148854,75 @@ "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "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": "size of the disk volume", + "name": "size", "type": "long" }, { - "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 read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "name of the disk offering", @@ -146326,9 +148930,14 @@ "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { "description": "the date the volume was attached to a VM instance", @@ -146336,136 +148945,191 @@ "type": "date" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "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 status of the volume", + "name": "status", + "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": "name of the disk volume", - "name": "name", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { "description": "state of the virtual machine", @@ -146473,73 +149137,89 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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": "name of the availability zone", - "name": "zonename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + {}, { "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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 state of the disk volume", - "name": "state", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" } ] @@ -146549,6 +149229,21 @@ "isasync": false, "name": "listVMSnapshot", "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": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -146567,33 +149262,26 @@ "type": "list" }, { - "description": "the ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "lists snapshot by snapshot name or display name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The ID of the VM snapshot", "length": 255, - "name": "account", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -146604,67 +149292,58 @@ "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": "state of the virtual machine snapshot", + "description": "List by keyword", "length": 255, - "name": "state", + "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.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "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": "lists snapshot by snapshot name or display name", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "The ID of the VM snapshot", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "state", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createVMSnapshot", "response": [ { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, - {}, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { @@ -146677,23 +149356,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -146702,36 +149381,42 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + {}, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "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" }, { @@ -146740,60 +149425,61 @@ "type": "state" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", - "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": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" }, + {}, { "description": "the parent displayName of the vm snapshot", "name": "parentName", @@ -146805,39 +149491,33 @@ "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, - { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, { "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", "type": "string" } ], @@ -146855,6 +149535,13 @@ "required": false, "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, + "name": "nextaclruleid", + "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, @@ -146876,56 +149563,38 @@ "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, - "name": "nextaclruleid", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "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 starting port of ACL's port range", - "name": "startport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -146933,19 +149602,15 @@ "name": "state", "type": "string" }, + {}, { "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -146958,38 +149623,38 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag 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" }, { @@ -146998,43 +149663,58 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, - {}, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, { "description": "an explanation on why this ACL rule is being applied", "name": "reason", "type": "string" }, + {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -147043,14 +149723,6 @@ "isasync": true, "name": "disassociateIpAddress", "params": [ - { - "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", - "length": 255, - "name": "ipaddress", - "required": false, - "since": "4.19.0", - "type": "string" - }, { "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", "length": 255, @@ -147058,23 +149730,27 @@ "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" + }, + { + "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", + "length": 255, + "name": "ipaddress", + "required": false, + "since": "4.19.0", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -147082,7 +149758,11 @@ "name": "jobstatus", "type": "integer" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -147098,25 +149778,25 @@ "type": "string" }, { - "description": "DHCP server device ID", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "DHCP server device ID", "length": 255, - "name": "page", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { "description": "the Physical Network ID", @@ -147127,50 +149807,50 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "device id of ", "name": "id", "type": "string" }, - {}, { "description": "name of the provider", "name": "dhcpservertype", "type": "string" }, - {}, { - "description": "url", - "name": "url", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "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", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -147192,136 +149872,131 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the storage pool path", - "name": "path", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the tags for the storage pool", + "name": "tags", "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 ID of the storage pool", - "name": "id", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "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 name of the storage pool", - "name": "name", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "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 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 tags for the storage pool", - "name": "tags", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, + {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, {}, { - "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 nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -147329,29 +150004,39 @@ "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { "description": "the storage pool custom stats", "name": "storagecustomstats", "type": "map" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" } ] }, @@ -147376,17 +150061,17 @@ "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", @@ -147414,96 +150099,60 @@ "description": "the list params the api accepts", "name": "params", "response": [ - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, { "description": "parameter type", "name": "type", "type": "string" }, - {}, { "description": "the name of the api parameter", "name": "name", "type": "string" }, - { - "description": "length of the parameter", - "name": "length", - "type": "int" - }, { "description": "true if this parameter is required for the api request", "name": "required", "type": "boolean" }, { - "description": "description of the api parameter", - "name": "description", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, + {}, { "description": "comma separated related apis to get the parameter", "name": "related", "type": "string" + }, + { + "description": "description of the api parameter", + "name": "description", + "type": "string" + }, + { + "description": "length of the parameter", + "name": "length", + "type": "int" } ], "type": "set" }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, - { - "description": "response field type", - "name": "type", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" - }, - { - "description": "description of the api", - "name": "description", - "type": "string" - }, - {}, { "description": "the name of the api command", "name": "name", "type": "string" }, + {}, { - "description": "comma separated related apis", - "name": "related", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description of the api", + "name": "description", "type": "string" }, - {}, { "description": "api response fields", "name": "response", "response": [ - { - "description": "description of the api response field", - "name": "description", - "type": "string" - }, { "description": "api response fields", "name": "response", @@ -147514,6 +150163,11 @@ "name": "name", "type": "string" }, + { + "description": "description of the api response field", + "name": "description", + "type": "string" + }, { "description": "response field type", "name": "type", @@ -147521,6 +150175,37 @@ } ], "type": "set" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "comma separated related apis", + "name": "related", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" + }, + { + "description": "response field type", + "name": "type", + "type": "string" } ], "since": "4.1.0" @@ -147540,9 +150225,15 @@ } ], "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -147552,16 +150243,10 @@ }, {}, { - "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" - }, - {} + } ] }, { @@ -147569,6 +150254,13 @@ "isasync": true, "name": "createVMSnapshot", "params": [ + { + "description": "The description of the snapshot", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "The ID of the vm", "length": 255, @@ -147577,13 +150269,6 @@ "required": true, "type": "uuid" }, - { - "description": "The description of the snapshot", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The display name of the snapshot", "length": 255, @@ -147592,16 +150277,16 @@ "type": "string" }, { - "description": "snapshot memory if true", + "description": "quiesce vm if true", "length": 255, - "name": "snapshotmemory", + "name": "quiescevm", "required": false, "type": "boolean" }, { - "description": "quiesce vm if true", + "description": "snapshot memory if true", "length": 255, - "name": "quiescevm", + "name": "snapshotmemory", "required": false, "type": "boolean" } @@ -147609,25 +150294,23 @@ "related": "", "response": [ { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, - {}, - {}, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { @@ -147636,146 +150319,143 @@ "type": "integer" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "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 name of the vm snapshot", - "name": "name", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "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": "the display name of the vm snapshot", - "name": "displayname", + "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", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the state of the vm snapshot", "name": "state", "type": "state" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "the display name of the vm snapshot", + "name": "displayname", "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 account associated with the disk volume", - "name": "account", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "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": "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" + }, + { + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, { "description": "the Zone ID of the vm snapshot", @@ -147783,14 +150463,19 @@ "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.2.0" @@ -147810,27 +150495,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" } ], "since": "4.2.0" @@ -147841,19 +150526,11 @@ "name": "listTungstenFabricTagType", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric tag type", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "tagtypeuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -147870,46 +150547,54 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag type", + "description": "", "length": 255, - "name": "tagtypeuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { "description": "Tungsten-Fabric tag type name", "name": "name", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -147919,19 +150604,19 @@ "name": "extractSnapshot", "params": [ { - "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" }, { - "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" @@ -147940,24 +150625,23 @@ "related": "", "response": [ { - "description": "the name of the extracted object", - "name": "name", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "", + "name": "resultstring", "type": "string" }, - {}, { "description": "the account id to which the extracted object belongs", "name": "accountid", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { @@ -147966,8 +150650,18 @@ "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the id of extracted object", + "name": "id", + "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", "type": "string" }, { @@ -147976,18 +150670,23 @@ "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", "type": "integer" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { @@ -147996,31 +150695,17 @@ "type": "string" }, { - "description": "the id of extracted object", - "name": "id", - "type": "string" - }, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, {}, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "zone name the object was extracted from", - "name": "zonename", + "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" - } + {} ], "since": "4.20.0" }, @@ -148029,6 +150714,14 @@ "isasync": false, "name": "listSSHKeyPairs", "params": [ + { + "description": "the ID of the ssh keypair", + "length": 255, + "name": "id", + "related": "listSSHKeyPairs", + "required": false, + "type": "uuid" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -148043,14 +150736,6 @@ "required": false, "type": "string" }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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, @@ -148059,99 +150744,93 @@ "type": "boolean" }, { - "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 ssh keypair", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "A key pair name to look for", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "A public key fingerprint to look for", + "description": "A key pair name to look for", "length": 255, - "name": "fingerprint", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "A public key fingerprint to look for", "length": 255, - "name": "page", + "name": "fingerprint", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the project name of the keypair owner", - "name": "project", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the owner of the keypair", - "name": "account", + "description": "Name of the keypair", + "name": "name", "type": "string" }, - {}, { - "description": "the domain id of the keypair owner", - "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 project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "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", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { @@ -148160,13 +150839,19 @@ "type": "boolean" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, + {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -148188,76 +150873,70 @@ "related": "", "response": [ { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "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": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, - {}, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, - {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { "description": "the nfs mount options for the storage pool", @@ -148265,28 +150944,28 @@ "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 storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { @@ -148295,58 +150974,69 @@ "type": "storagepoolstatus" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "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 host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -148357,12 +151047,12 @@ "name": "updateSnapshotPolicy", "params": [ { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "the ID of the snapshot policy", @@ -148373,108 +151063,108 @@ "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to the display the snapshot policy to the end user or not.", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { @@ -148483,23 +151173,23 @@ "type": "short" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" } ] @@ -148510,11 +151200,11 @@ "name": "quotaSummary", "params": [ { - "description": "Optional, to list all accounts irrespective of the quota activity", + "description": "Optional, Account Id for which statement needs to be generated", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -148524,87 +151214,92 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "Optional, to list all accounts irrespective of the quota activity", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "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": "if the account has the quota config enabled", - "name": "quotaenabled", - "type": "boolean" + "description": "account balance", + "name": "balance", + "type": "bigdecimal" }, { - "description": "end date", - "name": "enddate", + "description": "start date", + "name": "startdate", "type": "date" }, + { + "description": "domain name", + "name": "domain", + "type": "string" + }, {}, + { + "description": "domain id", + "name": "domainid", + "type": "string" + }, + { + "description": "account state", + "name": "state", + "type": "state" + }, { "description": "quota usage of this period", "name": "quota", "type": "bigdecimal" }, { - "description": "account id", - "name": "accountid", - "type": "string" - }, - { - "description": "start date", - "name": "startdate", - "type": "date" + "description": "if the account has the quota config enabled", + "name": "quotaenabled", + "type": "boolean" }, { - "description": "currency", - "name": "currency", + "description": "account name", + "name": "account", "type": "string" }, {}, { - "description": "account state", - "name": "state", - "type": "state" + "description": "end date", + "name": "enddate", + "type": "date" }, { - "description": "domain name", - "name": "domain", + "description": "account id", + "name": "accountid", "type": "string" }, { @@ -148613,13 +151308,8 @@ "type": "string" }, { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" - }, - { - "description": "domain id", - "name": "domainid", + "description": "currency", + "name": "currency", "type": "string" } ], @@ -148642,19 +151332,8 @@ "related": "", "response": [ { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the async command executed", - "name": "cmd", - "type": "string" - }, - {}, - { - "description": "the user that executed the async command", - "name": "userid", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { @@ -148662,26 +151341,28 @@ "name": "jobinstanceid", "type": "string" }, + {}, + {}, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" - }, - { - "description": "the result type", - "name": "jobresulttype", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", "type": "integer" }, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, + { + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" + }, { "description": "the msid of the management server on which the job is running", "name": "managementserverid", @@ -148693,8 +151374,8 @@ "type": "string" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { @@ -148703,35 +151384,44 @@ "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", + "description": "the async command executed", + "name": "cmd", + "type": "string" + }, + { + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", "type": "integer" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", + "description": "the result type", + "name": "jobresulttype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { "description": " the completed date of the job", "name": "completed", "type": "date" }, - {}, { "description": " the created date of the job", "name": "created", "type": "date" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" } ] }, @@ -148748,18 +151438,18 @@ "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "numretries", + "name": "ipaddress", "required": true, - "type": "integer" + "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "numretries", "required": true, - "type": "string" + "type": "integer" }, { "description": "Credentials to reach netscaler controlcenter device", @@ -148772,50 +151462,40 @@ "related": "addNetscalerLoadBalancer", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "device name", + "name": "lbdevicename", "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" - }, - {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {}, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "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 public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { @@ -148824,13 +151504,18 @@ "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device state", + "name": "lbdevicestate", "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": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { @@ -148838,25 +151523,30 @@ "name": "isexclusivegslbprovider", "type": "boolean" }, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "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", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" } ] }, @@ -148866,42 +151556,38 @@ "name": "createCounter", "params": [ { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Name of the counter.", "length": 255, - "name": "value", + "name": "name", "required": true, "type": "string" }, { - "description": "Name of the counter.", + "description": "Source of the counter.", "length": 255, - "name": "name", + "name": "source", "required": true, "type": "string" }, { - "description": "Network provider of the counter.", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "provider", + "name": "value", "required": true, - "since": "4.18.0", "type": "string" }, { - "description": "Source of the counter.", + "description": "Network provider of the counter.", "length": 255, - "name": "source", + "name": "provider", "required": true, + "since": "4.18.0", "type": "string" } ], "related": "", "response": [ - { - "description": "Provider of the counter.", - "name": "provider", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -148913,32 +151599,36 @@ "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, - {}, { "description": "Source of the counter.", "name": "source", "type": "string" }, + {}, + { + "description": "the id of the Counter", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Provider of the counter.", + "name": "provider", "type": "string" - }, - {} + } ] }, { @@ -148949,21 +151639,21 @@ "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": "Event Type", "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" }, + {}, {} ] }, @@ -148985,20 +151675,14 @@ "response": [ {}, { - "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", + "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" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, { "description": "Indicates whether a shutdown has been triggered", @@ -149006,14 +151690,20 @@ "type": "boolean" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "The id of the management server", - "name": "managementserverid", + "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" @@ -149024,26 +151714,33 @@ "name": "addCluster", "params": [ { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "publicvswitchname", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the username for the VSM associated with this cluster", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "vsmusername", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vsmpassword", + "required": false, + "type": "string" }, { "description": "the cluster name", @@ -149053,26 +151750,25 @@ "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": "the username for the VSM associated with this cluster", "length": 255, - "name": "guestvswitchtype", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "the URL", + "description": "the password for the host", "length": 255, - "name": "url", + "name": "password", "required": false, "type": "string" }, { - "description": "the Zone ID for the cluster", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "vsmipaddress", + "required": false, + "type": "string" }, { "description": "type of the cluster: CloudManaged, ExternalManaged", @@ -149082,65 +151778,67 @@ "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "the URL", "length": 255, - "name": "ovm3cluster", + "name": "url", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "hypervisor", - "required": true, + "name": "publicvswitchname", + "required": false, "type": "string" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the username for the cluster", "length": 255, - "name": "guestvswitchname", + "name": "username", "required": false, "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "ovm3vip", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "the username for the cluster", + "description": "the Pod ID for the host", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "vsmipaddress", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "ovm3pool", + "name": "ovm3vip", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "the Zone ID for the cluster", "length": 255, - "name": "password", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "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" }, @@ -149152,46 +151850,43 @@ "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "guestvswitchtype", "required": false, - "since": "4.20", "type": "string" } ], "related": "", "response": [ { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "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": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { @@ -149199,53 +151894,27 @@ "name": "cpuovercommitratio", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Ovm3 VIP to use for pooling and/or clustering", "name": "ovm3vip", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the capacity of the Cluster", "name": "capacity", @@ -149256,43 +151925,53 @@ "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -149301,37 +151980,48 @@ "type": "long" }, { - "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 Cluster ID", + "name": "clusterid", "type": "string" } ], "type": "list" }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, { "description": "the type of the cluster", "name": "clustertype", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the cluster name", - "name": "name", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" } ] }, @@ -149350,17 +152040,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": "any text associated with the success or failure", "name": "displaytext", @@ -149371,6 +152050,17 @@ "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" } ] }, @@ -149395,174 +152085,194 @@ "required": true, "type": "uuid" } - ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + ], + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "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": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "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": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], "type": "set" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "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" }, { @@ -149570,26 +152280,76 @@ "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 list of ingress rules associated with the security group", - "name": "ingressrule", + "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 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 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 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": "account owning the security group rule", + "name": "account", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -149598,28 +152358,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -149628,75 +152388,70 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "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 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 CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -149706,14 +152461,24 @@ "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 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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -149722,8 +152487,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -149732,13 +152497,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -149747,26 +152507,26 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -149783,92 +152543,62 @@ "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, - { - "description": "the 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 resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -149877,261 +152607,237 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - }, - { - "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], "type": "set" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 affinity group", + "name": "name", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 account associated with the virtual machine", - "name": "account", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -150140,354 +152846,343 @@ "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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": "publicipid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "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 domain name of the affinity group", - "name": "domain", + "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the 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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - {}, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the 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 VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "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": "the project name of the vm", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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 high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "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", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Guest vm Boot Type", + "name": "boottype", "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 password (if exists) of the virtual machine", - "name": "password", + "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": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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 name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -150497,19 +153192,19 @@ "name": "listDedicatedHosts", "params": [ { - "description": "", + "description": "list dedicated hosts by affinity group", "length": 255, - "name": "page", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the domain associated with the host", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -150526,117 +153221,74 @@ "type": "string" }, { - "description": "list dedicated hosts by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the host", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the host", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the domain ID of the host", - "name": "domainid", - "type": "string" - }, - { - "description": "the Account ID of the host", - "name": "accountid", - "type": "string" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the host", - "name": "hostid", + "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 Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, + {}, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the Account ID of the host", + "name": "accountid", "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": "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", + "description": "the name of the host", + "name": "hostname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" - } - ], - "since": "4.14.0.0" + {} + ] }, { "description": "upload an existing ISO into the CloudStack cloud.", @@ -150644,25 +153296,26 @@ "name": "getUploadParamsForIso", "params": [ { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "ispublic", + "name": "bootable", "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": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "format", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "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", @@ -150673,33 +153326,19 @@ "type": "uuid" }, { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "true if the ISO or its derivatives are extractable; default is false", + "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": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "name": "checksum", "required": false, "type": "string" }, { - "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": "the name of the volume/template/iso", @@ -150709,43 +153348,58 @@ "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "true if you want this ISO to be featured", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "isfeatured", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "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 format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, + {}, { "description": "the timestamp after which the signature expires", "name": "expires", @@ -150757,9 +153411,9 @@ "type": "uuid" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { "description": "the current status of the latest async job acting on this object", @@ -150767,12 +153421,10 @@ "type": "integer" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -150781,6 +153433,49 @@ ], "since": "4.13" }, + { + "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": "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", + "type": "string" + }, + {} + ], + "since": "4.14.0.0" + }, { "description": "Deletes a autoscale vm group.", "isasync": true, @@ -150804,17 +153499,6 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -150825,6 +153509,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" } ] }, @@ -150833,6 +153528,13 @@ "isasync": false, "name": "listPaloAltoFirewalls", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -150844,50 +153546,33 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "listPaloAltoFirewalls", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "keyword", + "name": "fwdeviceid", + "related": "listPaloAltoFirewalls", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "device state", "name": "fwdevicestate", @@ -150898,71 +153583,81 @@ "name": "usageinterface", "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 private security zone of the external firewall", - "name": "privatezone", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "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", "type": "string" }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" + }, { "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": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "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", + "description": "the public security zone of the external firewall", + "name": "publiczone", "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 public interface of the external firewall", - "name": "publicinterface", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" } ] @@ -150973,25 +153668,27 @@ "name": "updateLoadBalancerRule", "params": [ { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "algorithm", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", "required": false, "type": "string" }, { - "description": "The protocol for the LB", + "description": "the ID of the load balancer rule to update", "length": 255, - "name": "protocol", - "required": false, - "type": "string" + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -151002,20 +153699,18 @@ "type": "string" }, { - "description": "the ID of the load balancer rule to update", + "description": "The protocol for the LB", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "protocol", + "required": false, + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "the name of the load balancer rule", @@ -151027,121 +153722,50 @@ ], "related": "listLoadBalancerRules", "response": [ - {}, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - {}, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "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 id of the zone the rule belongs to", "name": "zoneid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the public port", "name": "publicport", "type": "string" }, - { - "description": "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 ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, { "description": "the private port", "name": "privateport", "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", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, + {}, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -151154,8 +153778,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -151164,18 +153788,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -151184,27 +153808,98 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the 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 id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + {}, + { + "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 protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "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" } ] }, @@ -151213,6 +153908,14 @@ "isasync": false, "name": "enableAccount", "params": [ + { + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "Enables specified account.", "length": 255, @@ -151227,103 +153930,149 @@ "related": "enableAccount,listAccounts", "required": false, "type": "uuid" - }, - { - "description": "Enables specified account in this domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" } ], "related": "listAccounts", "response": [ + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, { "description": "the total number of cpu cores the account can own", "name": "cpulimit", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, - {}, { "description": "the total number of networks the account can own", "name": "networklimit", "type": "string" }, - {}, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "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", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { "description": "the date when this account was created", "name": "created", "type": "date" }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "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 templates which can be created by this account", "name": "templatelimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total number of 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 number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -151332,29 +154081,29 @@ "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of 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 primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the total memory (in MB) owned by account", @@ -151362,123 +154111,173 @@ "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "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 total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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 account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "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", + "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 domain name of the user", "name": "domain", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, { "description": "the user lastname", "name": "lastname", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the account type of the user", @@ -151486,192 +154285,98 @@ "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", + "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 ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the name of the role", + "name": "rolename", "type": "string" } ], "type": "list" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the account", - "name": "name", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "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": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, + {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" } ] }, @@ -151680,6 +154385,14 @@ "isasync": true, "name": "changeStoragePoolScope", "params": [ + { + "description": "the Id of the storage pool", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "the scope of the storage: cluster or zone", "length": 255, @@ -151694,24 +154407,21 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "the Id of the storage pool", - "length": 255, - "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 UUID of the latest async job acting on this object", "name": "jobid", @@ -151721,11 +154431,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.19.1" @@ -151757,17 +154462,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" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -151793,53 +154498,49 @@ "related": "", "response": [ { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "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 after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -151848,119 +154549,153 @@ "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "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 X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + } + ], + "type": "list" + }, + { + "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": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the 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 the host", - "name": "name", + "description": "the admin that annotated this host", + "name": "username", "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": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", @@ -151968,80 +154703,75 @@ "type": "boolean" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, - {}, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "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 date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { "description": "true if the host is disconnected. False otherwise.", "name": "disconnected", "type": "date" }, + {}, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the amount of the host's CPU currently allocated in MHz", @@ -152049,33 +154779,48 @@ "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "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", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { @@ -152083,105 +154828,65 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "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 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": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "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 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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "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": "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 OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "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": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" } ] }, @@ -152202,13 +154907,18 @@ "related": "", "response": [ { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "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": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { @@ -152217,28 +154927,28 @@ "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "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 Kubernetes cluster", + "name": "name", + "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": "Minimum size of the cluster", - "name": "minsize", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { @@ -152247,53 +154957,64 @@ "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, + {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { @@ -152301,41 +155022,29 @@ "name": "autoscalingenabled", "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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 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 domain in which the Kubernetes cluster exists", - "name": "domainid", + "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 Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { @@ -152344,18 +155053,19 @@ "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 Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { @@ -152364,33 +155074,28 @@ "type": "clustertype" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" - }, - { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "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 cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" } ] @@ -152400,14 +155105,6 @@ "isasync": true, "name": "deleteProject", "params": [ - { - "description": "true if all project resources have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "id of the project to be deleted", "length": 255, @@ -152415,6 +155112,14 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "true if all project resources have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], "response": [ @@ -152424,21 +155129,21 @@ "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" } ], "since": "3.0.0" @@ -152451,23 +155156,23 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", @@ -152477,13 +155182,13 @@ "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", @@ -152509,41 +155214,41 @@ "related": "listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 projects the template is available for", - "name": "projectids", - "type": "list" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, - {}, - {}, { "description": "the list of accounts the template is available for", "name": "account", "type": "list" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" } ] }, @@ -152552,13 +155257,6 @@ "isasync": true, "name": "addNetscalerLoadBalancer", "params": [ - { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" - }, { "description": "public IP of the site", "length": 255, @@ -152567,46 +155265,46 @@ "type": "string" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, { - "description": "private IP of the site", - "length": 255, - "name": "gslbproviderprivateip", - "required": false, - "type": "string" - }, - { - "description": "true if NetScaler device being added is for providing GSLB service", + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", "length": 255, - "name": "gslbprovider", + "name": "isexclusivegslbprovider", "required": false, "type": "boolean" }, { "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, - "name": "password", + "name": "networkdevicetype", "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": "private IP of the site", "length": 255, - "name": "isexclusivegslbprovider", + "name": "gslbproviderprivateip", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "URL of the netscaler load balancer appliance.", + "length": 255, + "name": "url", + "required": true, + "type": "string" }, { "description": "the Physical Network ID", @@ -152615,32 +155313,83 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "true if NetScaler device being added is for providing GSLB service", + "length": 255, + "name": "gslbprovider", + "required": false, + "type": "boolean" } ], "related": "", "response": [ + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "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 NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "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 management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + }, { "description": "public IP of the NetScaler representing GSLB site", "name": "gslbproviderpublicip", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { "description": "device state", "name": "lbdevicestate", "type": "string" }, - { - "description": "the 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", @@ -152652,61 +155401,128 @@ "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {} + ] + }, + { + "description": "List backup schedule of a VM", + "isasync": false, + "name": "listBackupSchedule", + "params": [ { - "description": "name of the provider", - "name": "provider", + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the interval type of the backup schedule", + "name": "intervaltype", + "type": "intervaltype" + }, + {}, + { + "description": "the time zone of the backup schedule", + "name": "timezone", "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": "time the backup is scheduled to be taken.", + "name": "schedule", + "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "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 management IP address of the external load balancer", - "name": "ipaddress", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Restore and attach a backed up volume to VM", + "isasync": true, + "name": "restoreVolumeFromBackupAndAttachToVM", + "params": [ + { + "description": "ID of the volume backed up", + "length": 255, + "name": "volumeid", + "required": true, "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "id of the VM where to attach the restored volume", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "ID of the VM backup", + "length": 255, + "name": "backupid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "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": "Removes network permissions.", @@ -152714,20 +155530,19 @@ "name": "removeNetworkPermissions", "params": [ { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accountids", - "related": "listAccounts", + "name": "accounts", "required": false, "type": "list" }, { - "description": "the network ID", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "name": "accountids", + "related": "listAccounts", + "required": false, + "type": "list" }, { "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", @@ -152738,18 +155553,19 @@ "type": "list" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "the network ID", "length": 255, - "name": "accounts", - "required": false, - "type": "list" + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "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", @@ -152757,16 +155573,16 @@ "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.17.0" @@ -152777,43 +155593,43 @@ "name": "configTungstenFabricService", "params": [ { - "description": "the ID of physical network", + "description": "the ID of zone", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the ID of zone", + "description": "the ID of physical network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "physicalnetworkid", + "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ] @@ -152837,13 +155653,6 @@ "required": false, "type": "integer" }, - { - "description": "Pxe server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "", "length": 255, @@ -152858,6 +155667,13 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "Pxe server device ID", + "length": 255, + "name": "id", + "required": false, + "type": "long" } ], "related": "", @@ -152867,6 +155683,18 @@ "name": "id", "type": "string" }, + {}, + {}, + { + "description": "url", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -152881,19 +155709,7 @@ "description": "name of the provider", "name": "provider", "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "url", - "name": "url", - "type": "string" - }, - {} + } ] }, { @@ -152912,28 +155728,18 @@ "related": "", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "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 user lastname", - "name": "lastname", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -152942,84 +155748,85 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" }, + {}, { "description": "the user firstname", "name": "firstname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the user state", - "name": "state", + "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 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 user email address", - "name": "email", + "description": "the user ID", + "name": "id", "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 type of the role", - "name": "roletype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the secret key of the user", - "name": "secretkey", + "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": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + {}, + { + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -153028,20 +155835,34 @@ "type": "integer" }, { - "description": "the user ID", - "name": "id", + "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 ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" } ] }, @@ -153051,26 +155872,26 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "the public IP address ID of the load balancer rule", + "description": "the name of the load balancer rule", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "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.", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "isrecursive", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list by network ID the rule belongs to", @@ -153088,6 +155909,14 @@ "required": false, "type": "uuid" }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -153106,26 +155935,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "the ID of the virtual machine of the load balancer rule", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "the availability zone ID", "length": 255, @@ -153142,122 +155955,74 @@ "type": "map" }, { - "description": "the name of the load balancer rule", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "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", + "name": "page", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "projectid", - "related": "", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "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", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, + {}, { "description": "the load balancer rule ID", "name": "id", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { @@ -153266,45 +156031,43 @@ "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, - {}, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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 state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -153313,43 +156076,101 @@ "type": "integer" }, { - "description": "the project name of the load balancer", - "name": "project", + "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 public port", + "name": "publicport", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, + {}, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "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", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -153360,31 +156181,31 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "The netmask for the management network.", + "description": "The ending IP address.", "length": 255, - "name": "netmask", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { - "description": "The ending IP address.", + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", "length": 255, - "name": "endip", + "name": "vlan", "required": false, "type": "string" }, { - "description": "The gateway for the management network.", + "description": "The starting IP address.", "length": 255, - "name": "gateway", + "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", + "description": "The gateway for the management network.", "length": 255, - "name": "vlan", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { @@ -153395,9 +156216,9 @@ "type": "boolean" }, { - "description": "The starting IP address.", + "description": "The netmask for the management network.", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, @@ -153417,6 +156238,47 @@ "name": "netmask", "type": "string" }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", @@ -153427,117 +156289,66 @@ "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the gateway for the range", + "name": "gateway", "type": "string" } ], "type": "list" }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the allocation state of the Pod", "name": "allocationstate", "type": "string" }, - {}, { - "description": "the ID of the Pod", - "name": "id", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "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 if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -153546,13 +156357,23 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -153561,13 +156382,13 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -153579,19 +156400,19 @@ "description": "the Pod name", "name": "podname", "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 Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.11.0.0" @@ -153602,19 +156423,19 @@ "name": "listCiscoNexusVSMs", "params": [ { - "description": "", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -153624,26 +156445,26 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "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" }, { @@ -153652,34 +156473,23 @@ "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", "type": "int" }, - {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { @@ -153688,30 +156498,41 @@ "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": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, { "description": "The Device State (Enabled/Disabled) of the VSM", "name": "vsmdevicestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" + }, + {}, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" } ] }, @@ -153720,6 +156541,13 @@ "isasync": true, "name": "addVpnUser", "params": [ + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "add vpn user to the specific project", "length": 255, @@ -153729,19 +156557,12 @@ "type": "uuid" }, { - "description": "password for the username", + "description": "username for the vpn user", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, - { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -153751,73 +156572,121 @@ "type": "uuid" }, { - "description": "username for the vpn user", + "description": "password for the username", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the username of the vpn user", + "name": "username", + "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 state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", "name": "state", "type": "string" }, + {}, { "description": "the domain name of the account of the remote access vpn", "name": "domain", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" + }, + {}, { "description": "the vpn userID", "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Delete VM backup", + "isasync": true, + "name": "deleteBackup", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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, + "name": "forced", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + } + ], + "response": [ {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the username of the vpn user", - "name": "username", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} - ] + } + ], + "since": "4.14.0" }, { "description": "Deletes a project role permission in the project", @@ -153825,17 +156694,17 @@ "name": "deleteProjectRolePermission", "params": [ { - "description": "ID of the project where the project role permission is to be deleted", + "description": "ID of the project role permission to be deleted", "length": 255, - "name": "projectid", + "name": "id", "related": "", "required": true, "type": "uuid" }, { - "description": "ID of the project role permission to be deleted", + "description": "ID of the project where the project role permission is to be deleted", "length": 255, - "name": "id", + "name": "projectid", "related": "", "required": true, "type": "uuid" @@ -153843,26 +156712,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ], "since": "4.15.0" @@ -153872,6 +156741,13 @@ "isasync": false, "name": "updateQuarantinedIp", "params": [ + { + "description": "The date when the quarantine will no longer be active.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, { "description": "The ID of the public IP address in active quarantine.", "length": 255, @@ -153886,22 +156762,11 @@ "name": "ipaddress", "required": false, "type": "string" - }, - { - "description": "The date when the quarantine will no longer be active.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" } ], "related": "", "response": [ - { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - }, + {}, { "description": "End date for the quarantine.", "name": "enddate", @@ -153913,15 +156778,24 @@ "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" + }, + { + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" }, { "description": "Account ID of the previous public IP address owner.", @@ -153930,8 +156804,13 @@ }, {}, { - "description": "ID of the quarantine process.", - "name": "id", + "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" }, { @@ -153939,16 +156818,6 @@ "name": "removed", "type": "date" }, - { - "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": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -153963,60 +156832,51 @@ "name": "updateVnfTemplate", "params": [ { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "sort key of the template, integer", "length": 255, - "name": "sshkeyenabled", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", - "length": 255, - "name": "vnfnics", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "map" + "type": "string" }, { - "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": "", + "name": "name", "required": false, - "type": "uuid" - }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "isrouting", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the format for the image", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "format", + "name": "cleanupvnfnics", "required": false, - "type": "string" + "type": "boolean" }, { - "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": "optional boolean field, which indicates if VNF nics will be cleaned up or not", + "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": "cleanupvnfnics", + "name": "cleanupdetails", "required": false, "type": "boolean" }, @@ -154028,24 +156888,16 @@ "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "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" }, @@ -154057,47 +156909,57 @@ "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "passwordenabled", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "the tag for this template.", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "templatetag", + "name": "templatetype", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "the format for the image", "length": 255, - "name": "bootable", + "name": "format", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "sortkey", + "name": "ostypeid", + "related": "", "required": false, - "type": "integer" + "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": "the tag for this template.", "length": 255, - "name": "cleanupdetails", + "name": "templatetag", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "the name of the image file", + "description": "the ID of the image file", "length": 255, - "name": "name", + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", @@ -154107,9 +156969,16 @@ "type": "map" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "requireshvm", + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", "required": false, "type": "boolean" } @@ -154117,24 +156986,34 @@ "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { "description": "the hypervisor on which the template runs", @@ -154142,68 +157021,159 @@ "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": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + {}, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "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", + "type": "boolean" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { @@ -154211,13 +157181,8 @@ "name": "tags", "response": [ { - "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" }, { @@ -154226,8 +157191,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -154236,13 +157201,13 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -154250,11 +157215,6 @@ "name": "account", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -154264,146 +157224,80 @@ "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "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 ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { "description": "the name of the secondary storage host for the template", "name": "hostname", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - {}, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the project id of the template", + "name": "projectid", "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 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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the 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 template name", - "name": "name", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { "description": "VMware only: additional key/value details tied with deploy-as-is template", @@ -154411,49 +157305,24 @@ "type": "map" }, { - "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 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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the status of the template", - "name": "status", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" } ], "since": "4.19.0" @@ -154463,6 +157332,21 @@ "isasync": true, "name": "updateVPCOffering", "params": [ + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" + }, + { + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" + }, { "description": "sort key of the VPC offering, integer", "length": 255, @@ -154471,16 +157355,17 @@ "type": "integer" }, { - "description": "the display text of the VPC offering", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "displaytext", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "the name of the VPC offering", + "description": "the display text of the VPC offering", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, @@ -154492,35 +157377,24 @@ "type": "string" }, { - "description": "the id of the VPC offering", - "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "the name of the VPC offering", "length": 255, - "name": "zoneid", + "name": "name", "required": false, - "since": "4.13", "type": "string" } ], "related": "", "response": [ { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -154528,64 +157402,45 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "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 vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the vpc offering", + "name": "name", + "type": "string" }, { "description": "true if network offering supports choosing AS numbers", "name": "specifyasnumber", "type": "boolean" }, + {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "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", - "type": "string" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { "description": "the internet protocol of the vpc offering", "name": "internetprotocol", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - {}, - { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" - }, - { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -154593,23 +157448,43 @@ "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability name", + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", "name": "name", "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -154620,41 +157495,21 @@ "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" } @@ -154665,30 +157520,110 @@ "type": "list" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "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": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Lists authorized users who can used SAML SSO", + "isasync": false, + "name": "listSamlAuthorization", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "User uuid", + "length": 255, + "name": "userid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the SAML authorization status", + "name": "status", "type": "boolean" + }, + { + "description": "the authorized Identity Provider ID", + "name": "idpid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "the user ID", + "name": "userid", + "type": "string" } ] }, @@ -154707,26 +157642,26 @@ ], "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 user two factor authenticator provider name", - "name": "name", + "description": "the description of the user two factor authenticator provider", + "name": "description", "type": "string" }, { - "description": "the description of the user two factor authenticator provider", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the user two factor authenticator provider name", + "name": "name", "type": "string" } ], @@ -154738,12 +157673,28 @@ "name": "scaleVirtualMachine", "params": [ { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "automigrate", + "name": "maxiops", "required": false, "since": "4.17", - "type": "boolean" + "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": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" }, { "description": "Verify OK to Shrink", @@ -154761,20 +157712,12 @@ "type": "map" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "maxiops", + "name": "automigrate", "required": false, "since": "4.17", - "type": "long" - }, - { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "type": "boolean" }, { "description": "The ID of the virtual machine", @@ -154783,29 +157726,10 @@ "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" - }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" } ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -154815,7 +157739,18 @@ "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" + }, + {} ] }, { @@ -154823,14 +157758,6 @@ "isasync": true, "name": "updateEgressFirewallRule", "params": [ - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the ID of the egress firewall rule", "length": 255, @@ -154846,13 +157773,31 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -154860,14 +157805,16 @@ "name": "icmpcode", "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 network id of the firewall rule", - "name": "networkid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -154875,39 +157822,28 @@ "name": "cidrlist", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, { "description": "the 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": "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -154916,8 +157852,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -154931,48 +157872,42 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { "description": "the public ip address for the firewall rule", @@ -154980,19 +157915,19 @@ "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.4" @@ -155003,34 +157938,34 @@ "name": "listOsCategories", "params": [ { - "description": "list Os category by id", + "description": "", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list os category by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "string" }, { - "description": "", + "description": "list Os category by id", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listOsCategories", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list os category by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "3.0.1", - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -155043,27 +157978,27 @@ "related": "", "response": [ { - "description": "the name of the OS category", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS category", + "name": "id", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the OS category", - "name": "id", + "description": "the name of the OS category", + "name": "name", "type": "string" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -155072,89 +158007,93 @@ "name": "listServiceOfferings", "params": [ { - "description": "name of the service offering", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "name", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "listall", + "name": "cpunumber", "required": false, - "type": "boolean" + "since": "4.15", + "type": "integer" }, { - "description": "listed offerings support root disk encryption", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "encryptroot", + "name": "isrecursive", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "ID of the service offering", + "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": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "the CPU number that listed offerings must support", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "cpunumber", + "name": "state", "required": false, - "since": "4.15", - "type": "integer" + "since": "4.19", + "type": "string" }, { - "description": "The ID of the template that listed offerings must support", + "description": "listed offerings support root disk encryption", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "encryptroot", "required": false, - "since": "4.20.0", - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { - "description": "id of zone disk offering is associated with", + "description": "is this a system vm offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "issystem", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" }, { - "description": "is this a system vm offering", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "issystem", + "name": "storagetype", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "", "length": 255, - "name": "systemvmtype", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "name of the service offering", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, - "since": "4.19", "type": "string" }, { @@ -155166,34 +158105,36 @@ "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "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 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 storage type of the service offering. Values are local and shared.", + "description": "", "length": 255, - "name": "storagetype", + "name": "page", "required": false, - "since": "4.19", - "type": "string" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -155203,104 +158144,72 @@ "type": "string" }, { - "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": "list only resources belonging to the domain specified", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "pagesize", + "name": "memory", "required": false, + "since": "4.15", "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "the RAM memory that listed offering must support", + "description": "ID of the service offering", "length": 255, - "name": "memory", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.15", - "type": "integer" + "type": "uuid" } ], "related": "updateServiceOffering", "response": [ { - "description": "the host tag for the service offering", - "name": "hosttags", - "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": "is true if the offering is customized", - "name": "iscustomized", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" - }, - { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, - {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, { "description": "the id of the service offering", "name": "id", @@ -155312,8 +158221,13 @@ "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", + "description": "the name of the service offering", + "name": "name", + "type": "string" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { @@ -155322,79 +158236,93 @@ "type": "integer" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "the max iops of the disk offering", + "name": "maxiops", "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": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, - {}, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "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 tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -155403,114 +158331,121 @@ "type": "long" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "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 default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", "type": "boolean" }, + {}, { - "description": "the 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": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "state of the service offering", + "name": "state", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, + {}, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "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": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" + }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" } ] }, @@ -155520,79 +158455,49 @@ "name": "importVm", "params": [ { - "description": "hypervisor type of the host", + "description": "the cluster ID", "length": 255, - "name": "hypervisor", + "name": "clusterid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "path of the disk image", + "description": "the host name of the instance", "length": 255, - "name": "diskpath", + "name": "hostname", "required": false, "type": "string" }, { - "description": "the username for the host", + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", "length": 255, - "name": "username", + "name": "datacentername", "required": false, "type": "string" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", - "length": 255, - "name": "convertinstancepoolid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "Shared storage pool where disk is located", - "length": 255, - "name": "storageid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "VM nic to network id mapping using keys nic and network", + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", "length": 255, - "name": "nicnetworklist", + "name": "clustername", "required": false, - "type": "map" + "type": "string" }, { - "description": "import instance for the project", + "description": "the network ID", "length": 255, - "name": "projectid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "description": "the display name of the instance", "length": 255, - "name": "clustername", + "name": "displayname", "required": false, "type": "string" }, - { - "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) 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 nic to ip address mapping using keys nic, ip4Address", "length": 255, @@ -155601,63 +158506,52 @@ "type": "map" }, { - "description": "Source location for Import", - "length": 255, - "name": "importsource", - "required": true, - "type": "string" - }, - { - "description": "the host name of the instance", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "hostname", + "name": "storageid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "datadiskofferinglist", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "map" - }, - { - "description": "the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, "type": "uuid" }, { - "description": "the network ID", + "description": "import instance for the project", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the cluster ID", + "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "clusterid", + "name": "convertinstancepoolid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", "length": 255, - "name": "datacentername", + "name": "importinstancehostid", + "related": "", "required": false, - "type": "string" + "since": "4.19.2", + "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": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "Host where local disk is located", @@ -155668,605 +158562,276 @@ "type": "uuid" }, { - "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": "(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "the username for the host", "length": 255, - "name": "vcenter", + "name": "username", "required": false, "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "description": "hypervisor type of the host", "length": 255, - "name": "existingvcenterid", - "related": "", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "the host name or IP address", + "description": "path of the disk image", "length": 255, - "name": "host", + "name": "diskpath", "required": false, "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "convertinstancehostid", - "related": "", + "name": "datadiskofferinglist", "required": false, - "type": "uuid" - }, - { - "description": "the name of the instance as it is known to the hypervisor", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "map" }, { - "description": "import instance to the domain specified", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "Temp Path on external host for disk image copy", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "temppath", + "name": "account", "required": false, "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "description": "the zone ID", "length": 255, - "name": "hostip", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "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" }, { - "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": "an optional account for the virtual machine. Must be used with domainId.", + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", "length": 255, - "name": "account", + "name": "hostip", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, - "name": "password", + "name": "vcenter", "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "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": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "migrateallowed", "required": false, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ - { - "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": "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "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": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "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", + "description": "import instance to the domain specified", + "length": 255, "name": "domainid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "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": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "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" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "related": "listDomains", + "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", + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": false, "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Temp Path on external host for disk image copy", + "length": 255, + "name": "temppath", + "required": false, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Source location for Import", + "length": 255, + "name": "importsource", + "required": true, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "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": "convertinstancehostid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "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": "(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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "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 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", + "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 name of the host for the virtual machine", + "name": "hostname", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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", + "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": "the ID of the corresponding network", - "name": "networkid", - "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": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 ip address of the nic", - "name": "ipaddress", - "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 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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the control state of the host for the virtual machine", @@ -156279,58 +158844,49 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "User VM type", - "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": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { @@ -156339,209 +158895,285 @@ "type": "date" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the 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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "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" - }, { "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 egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the 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": "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 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" }, { @@ -156549,8 +159181,13 @@ "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 value", + "name": "value", "type": "string" }, { @@ -156564,13 +159201,18 @@ "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -156583,11 +159225,6 @@ "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", @@ -156597,38 +159234,38 @@ "description": "customer associated with the tag", "name": "customer", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the project id of the group", "name": "projectid", @@ -156640,23 +159277,13 @@ "type": "string" }, { - "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 account owning the security group", - "name": "account", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -156665,203 +159292,525 @@ "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "account owning the security group rule", + "description": "the account associated with the tag", "name": "account", "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": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + {}, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + {}, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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 project ID of the affinity group", - "name": "projectid", + "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 domain name of the affinity group", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the 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": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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" } ], "since": "4.19.0" @@ -156890,22 +159839,22 @@ ], "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": "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", @@ -156919,45 +159868,45 @@ "name": "listAffinityGroupTypes", "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" } ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the type of the affinity group", "name": "type", "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" } ] }, @@ -156967,42 +159916,42 @@ "name": "listCapacity", "params": [ { - "description": "List by keyword", + "description": "Tag for the resource type", "length": 255, - "name": "keyword", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists capacity by the Cluster ID", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "clusterid", - "related": "", + "name": "sortby", "required": false, "since": "3.0.0", - "type": "uuid" + "type": "string" }, { - "description": "recalculate capacities and fetch the latest", + "description": "lists capacity by the Cluster ID", "length": 255, - "name": "fetchlatest", + "name": "clusterid", + "related": "", "required": false, "since": "3.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "Sort the results. Available values: Usage", + "description": "List by keyword", "length": 255, - "name": "sortby", + "name": "keyword", "required": false, - "since": "3.0.0", "type": "string" }, { @@ -157022,24 +159971,24 @@ "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": "", "length": 255, - "name": "type", + "name": "page", "required": false, "type": "integer" }, { - "description": "Tag for the resource type", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "tag", + "name": "fetchlatest", "required": false, - "since": "4.20.0", - "type": "string" + "since": "3.0.0", + "type": "boolean" }, { - "description": "", + "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": "pagesize", + "name": "type", "required": false, "type": "integer" } @@ -157047,44 +159996,34 @@ "related": "", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, { - "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 tag for the capacity type", + "name": "tag", + "type": "string" }, + {}, { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -157092,20 +160031,19 @@ "name": "capacityallocated", "type": "long" }, - {}, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -157113,15 +160051,26 @@ "name": "name", "type": "string" }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" } ] }, @@ -157130,6 +160079,14 @@ "isasync": false, "name": "updateServiceOffering", "params": [ + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "length": 255, + "name": "purgeresources", + "required": false, + "since": "4.20", + "type": "boolean" + }, { "description": "the ID of the service offering to be updated", "length": 255, @@ -157147,24 +160104,24 @@ "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "sort key of the service offering, integer", "length": 255, - "name": "zoneid", + "name": "sortkey", "required": false, - "since": "4.13", - "type": "string" + "type": "integer" }, { - "description": "the display text of the service offering to be updated", + "description": "the host tag for this service offering.", "length": 255, - "name": "displaytext", + "name": "hosttags", "required": false, + "since": "4.16", "type": "string" }, { - "description": "state of the service offering", - "length": 255, - "name": "state", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, "type": "string" }, @@ -157176,67 +160133,64 @@ "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "the display text of the service offering to be updated", "length": 255, - "name": "hosttags", + "name": "displaytext", "required": false, - "since": "4.16", "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", + "description": "state of the service offering", "length": 255, - "name": "purgeresources", + "name": "state", "required": false, - "since": "4.20", - "type": "boolean" + "type": "string" }, { - "description": "sort key of the service offering, integer", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "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", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" } ], "related": "", "response": [ { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the tags for the service offering", + "name": "storagetags", + "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": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, { "description": "the clock rate CPU speed in Mhz", @@ -157244,89 +160198,70 @@ "type": "integer" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "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": "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 date this service offering was created", - "name": "created", - "type": "date" - }, { "description": "length (in second) of the burst", "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "data transfer rate in megabits per second allowed.", - "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": "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 name of the service 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": "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": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "state of the service offering", + "name": "state", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -157334,39 +160269,48 @@ "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, - {}, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { @@ -157375,85 +160319,95 @@ "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "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", - "type": "string" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, + {}, { - "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": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", "type": "boolean" }, - {}, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { "description": "io requests read rate of the service offering", @@ -157461,29 +160415,24 @@ "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" } ] }, @@ -157492,13 +160441,6 @@ "isasync": true, "name": "stopVirtualMachine", "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). 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, @@ -157506,462 +160448,170 @@ "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "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" } ], "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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 IPv6 address of network", - "name": "ip6address", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "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" - } - ], - "type": "set" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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 host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, { "description": "NICs of the VNF appliance", "name": "vnfnics", "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "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 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": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the disk 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" }, { @@ -157969,10 +160619,25 @@ "name": "userdata", "type": "string" }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -157989,8 +160654,13 @@ "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", "type": "string" }, { @@ -158004,102 +160674,114 @@ "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "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 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 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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "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": "path of the Domain the security group belongs to", "name": "domainpath", @@ -158111,14 +160793,71 @@ "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 ID of the security group", - "name": "id", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { "description": "the project name of the group", @@ -158126,22 +160865,57 @@ "type": "string" }, { - "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the 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", + "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" }, { @@ -158149,38 +160923,38 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -158189,151 +160963,64 @@ "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": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the 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": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the 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 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 protocol of the security group rule", @@ -158345,23 +161032,13 @@ "name": "ruleid", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -158370,23 +161047,23 @@ "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": "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": "tag value", + "name": "value", "type": "string" }, { @@ -158395,13 +161072,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -158410,195 +161087,472 @@ "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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "the 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 domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the 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 name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "device type of the root volume", + "name": "rootdevicetype", "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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 ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "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", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" } ] @@ -158615,13 +161569,6 @@ "required": false, "type": "string" }, - { - "description": "Name of the network ACL list", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -158630,6 +161577,13 @@ "since": "4.4", "type": "boolean" }, + { + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "ID of the VPC associated with this network ACL list", "length": 255, @@ -158642,21 +161596,20 @@ "related": "", "response": [ { - "description": "the Name of the ACL", - "name": "name", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Description of the ACL", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -158668,23 +161621,24 @@ "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, + {}, + {}, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the Name of the ACL", + "name": "name", + "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "Description of the ACL", + "name": "description", "type": "string" - }, - {} + } ] } ], - "count": 826 + "count": 856 } diff --git a/test/AccountService_test.go b/test/AccountService_test.go index 3ffbdfef..fd8d2140 100644 --- a/test/AccountService_test.go +++ b/test/AccountService_test.go @@ -96,7 +96,7 @@ func TestAccountService(t *testing.T) { if _, ok := response["isAccountAllowedToCreateOfferingsWithTags"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Account.NewIsAccountAllowedToCreateOfferingsWithTagsParams() + p := client.Account.NewIsAccountAllowedToCreateOfferingsWithTagsParams("id") _, err := client.Account.IsAccountAllowedToCreateOfferingsWithTags(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/testdata/HostService.json b/test/testdata/HostService.json index a503e664..640c2401 100644 --- a/test/testdata/HostService.json +++ b/test/testdata/HostService.json @@ -346,7 +346,7 @@ "jobstatus": 0, "lastpinged": "1970-01-19T18:10:51+0000", "managementserverid": 2886860803, - "memoryallocated": "0%", + "memoryallocated": 0, "memoryallocatedbytes": 0, "memoryallocatedpercentage": "0%", "memorytotal": 8589934592,